https://github.com/7nmw/notes
Сервис управления заметками
https://github.com/7nmw/notes
django djangorestframework-simplejwt swagger
Last synced: 2 months ago
JSON representation
Сервис управления заметками
- Host: GitHub
- URL: https://github.com/7nmw/notes
- Owner: 7nmw
- Created: 2025-02-27T07:38:56.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-02-27T09:38:32.000Z (3 months ago)
- Last Synced: 2025-03-15T04:17:51.809Z (2 months ago)
- Topics: django, djangorestframework-simplejwt, swagger
- Language: Python
- Homepage:
- Size: 31.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# RESTful_API_notes
# REST API для сервиса управления заметками
Проект написан на Django REST Framework 3.15.2 (все остальные библиотеки лежат в requirements.txt)
Версия Python 3.10.6
ОС Windows 10
## Создана структура базы данных
Была использована база данных PostgreSQL.
***
## Логин, пароль и путь к базе данных получено из переменных окружения
* FSTR_DB_HOST: путь к базе данных;
* FSTR_DB_PORT: порт базы данных;
* FSTR_DB_LOGIN: логин, с которым происходит подключение к БД;
* FSTR_DB_PASS: пароль, с которым происходит подключение к БД.
## Реализован Rest API
Реализовано:
представления:
ListCreateAPIView – для чтения своих заметок (по GET-запросу) и создания заметок (по POST-запросу);
RetrieveUpdateDestroyAPIView – для чтения, изменения и удаления отдельной заметки (GET-, PUT-, и DELETE-запросы).
по адресу 'http://127.0.0.1:8000/notes/' пользователь получает все свои заметки
по адресу 'http://127.0.0.1:8000/notes//' пользователь получает выбранную заметку
по адресу 'http://127.0.0.1:8000/register/' можно пройти регистрацию
JWT аутентификацию с помощью simplejwt
по адресу 'http://127.0.0.1:8000/api/token/' после авторизации можно получить ACCESS и REFRESH токены
по адресу 'http://127.0.0.1:8000/api/token/refresh/' можно получить новый ACCESS токен
Ограничения
Только зарегистрированные пользователи могут создавать, получать, удалять свои заметки
## Была создана документация с помощью Swagger