Skip to content

Latest commit

 

History

History
352 lines (323 loc) · 15.9 KB

README.md

File metadata and controls

352 lines (323 loc) · 15.9 KB
Raw

Node.js AND Postgres. Rest API

Для реализации проекта:

  • Установка на ПК node.js
  • Установка на ПК PostgreSQL
  • Установка на ПК Postman
  • npm install express
  • npm install pg
  • npm install -D nodemon

1. Создание основного файла.

  1. Создаем файл index.js.
  2. Импортируем express.
const express = require('express');
  1. Зададим порт (можно из process || статический).
const PORT = process.env.PORT || 8080;
  1. Из express создадим сам сервер.
const app = express();
  1. Подключим слушатель на нашем порту.
app.listen(PORT, () => console.log(`Server started on port ${PORT}`));

2. Скрипты для старта приложения.

  1. В файле package.json пишем скрипт для запуска через node (start).
  2. В файле package.json пишем скрипт для запуска через nodemon (dev).

3. Запрос для проверки.

  1. Создать get для проверки работоспособности сервера.
app.get("/", (req, res) => {
  res.send(`hello postgres + nodeJS`);
});

4. Для подключения к Базе Данных.

  1. Создаем файл db.js.
  2. Получаем poll из установленного пакета pg.
const Pool = require('pg').Pool;
  1. Создаем объект этого класса. С его помощью будем делать запросы к БД.
const pool = new Pool();
  1. Экспортируем объект класса.
module.exports = pool;

5. Настраиваем объект класса Poll.

  1. Первое поле - это пользователь от которого мы будем подключатся к БД (user).
  2. Второе поле - Пароль, который вы указывали при создании (password).
  3. Третье поле - Указываем хост. В нашем случае - это локальная машина (host).
  4. Четвертое поле - указываем порт. По умолчанию при установке он указывается 5432 (port).
  5. Последнее свойство - это название базы данных(database). (его пока у нас нет, запишем, когда создадим БД).
const pool = new Pool({
  user: "postgres",
  password: "pass",
  host: "localhost",
  port: 5432,
  database: "database_name",
});

6. Создание Базы Данных.

  1. Открыть powershell и перейти по адресу установленного postgres в папку bin.
  2. Командой .\psql --version убеждаемся что postgresql установлен.
  3. Заходим в СУБД (.\psql -U postgres).
  4. Вводим пароль от пользователя. Команда \l покажет список существующих баз данных.
  5. Создать новую БД node_postgres_practic (create database node_postgres_practic).
  6. Подключаемся к Базе Данных (\connect node_postgres_practic). Командой \dt мы можем посмотреть существующие в БД таблицы.
  7. Переключаем кодировку на 1251 (psql \! chcp 1251).
  8. Теперь же мы можем добавить в параметры pool database: "node_postgres_practic".
const pool = new Pool({
  user: "postgres",
  password: "pass",
  host: "localhost",
  port: 5432,
  database: "node_postgres_practice",
});

7. Для большего понимания можно создать схему сущностей проекта.

  1. Создать схему с сущностями можно на сайте draw.io.
  2. Создать две сущности person и post.
  3. Создать поля сущностей person (id, name, surname).
  4. Создать поля сущностей post (id, title, content, user_id).
  5. Указать связь таблиц (один-ко-многим).

8. Создание таблиц сущностей в Базе Данных.

  1. Создать файл database.sql.
  2. Написать запрос на создание таблицы person.
create TABLE person(
 id SERIAL PRIMARY KEY,
 name VARCHAR(255),
 surname VARCHAR(255)
);
  1. Написать запрос на создание таблицы post.
create TABLE post(
 id SERIAL PRIMARY KEY,
 title VARCHAR(255),
 content VARCHAR(255),
 user_id INTEGER,
 FOREIGN KEY (user_id) REFERENCES person (id)
);
  1. Сделать запрос на создание таблицы person в powershell.
  2. Сделать запрос на создание таблицы post в powershell.

9. Запросы для person.

  1. Создадим папку controller для работы с запросами.
  2. Создадим файл user.controller.js.
  3. Создадим класс внутри которого будем определять методы class UserController.
  4. Первый метод будет создание пользователя (createUser).
  5. Вторая функция будет возвращать клиенту всех пользователей (getUsers).
  6. Третья функция будет возвращать конкретного пользователя по id (getOneUser).
  7. Четвертая функция будет обновлять данные о пользователе по id (updateUser).
  8. Пятая функция будет удалять пользователя по id (deleteUser).
  9. Экспортировать ОБЪЕКТ данного контроллера.
class UserController {
 async createUser(req, res){}
 async getUsers(req, res){}
 async getOneUser(req, res){}
 async updateUser(req, res){}
 async deleteUser(req, res){}
}

module.exports = new UserController();

10. Маршруты для person.

  1. Создадим папку routes для работы с маршрутами, по которым надо будет отправлять запросы.
  2. Создадим файл user.routes.js.
  3. Получаем из express роутер.
const Router = require("express");
  1. Создаем объект этого класса.
const router = new Router();
  1. Добавим экспорт нашей переменной router.
module.exports = router;
  1. Импортируем объект controller.
const userControler = require("../controller/user.controller");
  1. Для каждой из функций определим маршрут по которому она будет отрабатывать. Первая функция - это функция создания пользователя (post запрос).
  2. Далее у нас будет два get запроса: получить всех пользователей и получить одного пользователя.
  3. Put запрос для обновления данных.
  4. И delete запрос для удаления пользователя. Так же тут мы можем через двоеточие указать параметр.
const Router = require("express");
const router = new Router();
const userControler = require("../controller/user.controller");

router.post("/user", userControler.createUser);
router.get("/user", userControler.getUsers);
router.get("/user/:id", userControler.getOneUser);
router.put("/user", userControler.updateUser);
router.delete("/user/:id", userControler.deleteUser);

module.exports = router;

11. Регистрируем роутер.

  1. Переходим в файл index.js.
  2. Удаляем get запрос, который был для проверки.
  3. Далее у app воспользуемся функцией use в которую первым параметром передаем url по которому этот роутер будет обрабатывать ("/api"), вторым параметром передаем уже сам роутер.
app.use('/api', userRouter);
  1. Указываем express что нужно будет распаршивать json строку (app.use(express.json())).
app.use(express.json());

12. Реализация функций user.controller.js.

  1. Начнем с функции createUser.
  2. С помощью деструктуризацией получим из тела запроса имя и фамилию (req.body).
async createUser(req, res) {
		const { name, surname } = req.body;
		console.log(name, surname);
		res.json(ok);
}
  1. затем выводим в логи и ответом на клиент вернем просто ok (res.json("ok")).
  2. Проверить через postman. Отправлять запросы будем на следующий адрес: http://localhost:8080/api/user. Далее переходим к телу запроса (body -> row), и разрешение json, заполняем запрос рандомными именем и фамилией:{"name": "ivan","surname": "ivanov"}.

13. Реализуем записать пришедших данных в базу данных.

  1. В файле user.controller.js импортируем db который мы создавали ранее.
const db = require("../db");
  1. В функции createUser после получения данных из тела создаем нового пользователя.
  2. Создаем нового пользователя с помощью db, вызовем функцию query с sql запросом в параметре (INSERT INTO person (name, surname) values ($1, $2) RETURNING *, [1, 2]).
  3. Ответом на клиент вернем пользователя, а точнее только данные которые находятся в rows[0].
class UserController {
  async createUser(req, res) {
    const { name, surname } = req.body;
    const newPerson = await db.query("INSERT INTO person (name, surname) values ($1, $2) RETURNING *", [name, surname]);
    res.json(newPerson[0]);
  }
  async getUsers(req, res) {}
  async getOneUser(req, res) {}
  async updateUser(req, res) {}
  async deleteUser(req, res) {}
}
  1. Проверить через postman.

14. Реализация функции получения всех пользователей getUsers.

  1. Создаем новую переменную в которую мы будем помещать пользователей и так же пишем запрос.
  2. На клиент будем возвращать поле rows.
async getUsers(req, res) {
		const users = await db.query(`SELECT * FROM person`)
		res.json(users.rows)
}
  1. Проверить через postman.

15. Реализация функции получение конкретного пользователя getOneUser.

  1. Получаем id из параметров запроса (req.params.id).
  2. С помощью запроса выделяем пользователя из db.
  3. И на клиент вернем этого пользователя.
async getOneUser(req, res) {
		const id = req.params.id;
		const user = await db.query(`SELECT * FROM person WHERE id = $1`, [id]);
		res.json(user.rows[0]);
}
  1. Проверить через postman.

16. Реализация функции изменения пользователя по id. Функция updateUser.

  1. Получаем из запроса id новое имя name и новую фамилию surname.
  2. Далее пишем запрос (UPDATE person set name = $1, surname = $2 where id = $3 RETURNING *).
  3. И возвращаем на клиент результат запроса.
async updateUser(req, res) {
		const { id, name, surname } = req.body;
		const user = await db.query(
				`UPDATE person set name = $1, surname = $2 where id = $3 RETURNING *`,
				[name, surname, id]
		);
		res.json(user.rows[0]);
}
  1. Проверить через postman.

17. Реализация функции удалениz пользователя deleteUser.

  1. Узнаем id пользователя из запроса.
  2. Создаем запрос на удаление (DELETE FROM person WHERE id = $1).
  3. Возвращаем результат.
async deleteUser(req, res) {
		const id = req.params.id;
		const user = await db.query(`DELETE FROM person WHERE id = $1`, [id]);
		res.json(user.rows[0]);
}
  1. Проверить через postman.

18. Файлы для работы с post.

  1. Создаем файл post.controller.js.
  2. В нем создаем класс PostController.
  3. Экспортируем новый объект этого класса.
  4. Создаем две функции для создания и получения createPost и getPostsByUser.
class PostController {
 async createPost(req, res){}
 async getPostsByUser(req, res){}
}

module.exports = new PostController();

19. Создаем файл для post.routers.

  1. Импортировать Router из express.
  2. Cоздать новый объект класса Router.
  3. Импортировать postController.
  4. Создать post запрос для создания постов.
  5. Создать get запрос для получения постов пользователя.
  6. Экспортировать роутер.
const db = require("../db");

class PostController {
  async createPost(req, res) {}
  async getPostsByUser(req, res) {}
}

module.exports = new PostController();
  1. Регистрируем этот роутер в index.js файле.
const postRouter = require("./routes/post.routers");
  1. Запускаем метод use у app для postRouter.
app.use("/api", postRouter);

20. Реализации функций post.controller.js.

  1. При создании файла из тела функции достаем title и content.
  2. Делаем запрос на создание поста.
  3. Возвращаем на клиент созданный пост.
async createPost(req, res) {
		const { title, content, userId } = req.body;
		console.log(req.body);
		const newPost = await db.query(
				`INSERT INTO post (title, content, user_id) values ($1, $2, $3) RETURNING *`,
				[title, content, userId]
		);
		res.json(newPost.rows[0]);
}
  1. Создадим несколько постов с помощью postman.
  2. Проверить через postman.

21. Реализация функции для получения постов пользователя.

  1. Получаем id клиента из запроса.
  2. Выбираем все посты с помощью запроса.
  3. Возвращаем на клиент эти посты.
async getPostsByUser(req, res) {
		const id = req.query.id;
		const posts = await db.query(`select * from post where user_id = $1`, [id]);
		res.json(posts.rows);
}
  1. Проверить через postman.