https://github.com/archakov06/blog-api
https://github.com/archakov06/blog-api
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/archakov06/blog-api
- Owner: Archakov06
- Created: 2021-12-27T23:09:09.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-02-10T12:04:15.000Z (over 4 years ago)
- Last Synced: 2025-07-08T02:23:24.704Z (11 months ago)
- Language: JavaScript
- Size: 68.4 KB
- Stars: 7
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Установка
Перед тем, как запускать сервер, необходимо установить все зависимости.
Для этого выполни команду `yarn`.
# Настройка
1. Когда установка зависимостей завершилась, необходимо создать файл `.env`, вставив в этот новый файл всё содержимое из файла `.env.example`.
2. Теперь необходимо зарегистрироваться на сайте https://mongodb.com и скопировать ссылку на свою MongoDB базу данных.
3. Внутри файла `.env` есть строка `MONGODB_URI=XXX`, вместо `XXX` вставь ссылку на свою БД.
# Запуск
Для того чтобы запустить сам сервер, выполни команду `yarn start`. Теперь по адресу `http://localhost:5656` будет доступен сервер.
Ниже перечислены все доступные роуты.
# API документация (Apiary)
По адресу https://blogapi22.docs.apiary.io/ доступна вся документация по всем роутам с подробным объяснением того, что и как делает каждый роут.
Учитывай тот момент, что для создания статьи или комментария, тебе необходимо быть авторизованным. После произведения авторизации, бэкенд тебе в ответ вернёт `token`. Его необходимо передавать во все защищённые роуты внутри headers в свойство `Authorization`.
Вот пример запроса:
```js
axios.post(
`http://localhost:5656/posts`,
{
title: "Заголовок статьи",
text: "........",
},
{
headers: {
"Authorization": "ТУТ_ТОКЕН"
}
}
);
```
## Как пользоваться Apiariy?
1. Если ты хочешь тестировать запросы через сервис Apiary, то необходимо там переключится на "Use Browser", чтобы запросы не отправлялись через их сервис. Если не поменять, то всегда будет выдавать ошибку.
2. Чтобы отправить запрос, достаточно нажать на "Call Resource"
3. Если необходимо передать POST-параметры в запросе, то нажимаем на "Body" и указываем там JSON с параметрами.
## Apiary сложный, есть ли что-то проще?
Да, можно скачать Postman (https://www.postman.com/) и через него отправлять запросы.
Или же в своём приложении самим писать Axios-запросы и тестировать (но этот вариант не самый лёгкий).