https://github.com/pavelpatsey/inside_test_task
API на основе Django REST Framework. Реализация тестового задания на позицию Junior Developer
https://github.com/pavelpatsey/inside_test_task
django-rest-framework docker-compose python3
Last synced: 2 months ago
JSON representation
API на основе Django REST Framework. Реализация тестового задания на позицию Junior Developer
- Host: GitHub
- URL: https://github.com/pavelpatsey/inside_test_task
- Owner: PavelPatsey
- Created: 2022-09-01T09:44:09.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-11-23T11:51:30.000Z (over 3 years ago)
- Last Synced: 2025-01-30T22:49:45.855Z (over 1 year ago)
- Topics: django-rest-framework, docker-compose, python3
- Language: Python
- Homepage:
- Size: 113 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Проект inside_test_task
API на основе Django REST Framework. Реализация тестового задания на позицию Junior Developer. Описание задания находится по адресу ./Junior_Developer_task_description.txt, можно посмотреть по [ссылке](https://github.com/PavelPatsey/inside_test_task/blob/main/Junior_Developer_task_description.txt).
## Стек технологий
- проект написан на Python с использованием Django REST Framework;
- база данных - PostgreSQL;
- система управления версиями - git;
- [Docker](https://docs.docker.com/engine/install/ubuntu/), [Dockerfile](https://docs.docker.com/engine/reference/builder/), [Docker Compose](https://docs.docker.com/compose/).
## Решение с запуском только контейнера с проектом:
[ветка Dockerfile](https://github.com/PavelPatsey/inside_test_task/tree/feature/docker_only)
## Реализовано
- Кастомная JWT аутентификация.
- Требуемые в задании POST эндпоинты.
- GitHub Actions:
- Проверка кода на соответствие PEP8 и выполнение тестов, реализованных в проекте.
- Сборка и публикация образа приложения на DockerHub.
## Образ Docker
Образ Docker находится в репозитории по адресу:
https://hub.docker.com/repository/docker/pavelpatsey/inside_project
## Запуск проекта в Docker Compose:
1. Склонируйте репозиторий.
2. В каталоге ./infra создайте файл .env c аналогичной структурой:
```
DB_ENGINE=django.db.backends.postgresql # указываем, что работаем с postgresql
DB_NAME=postgres # имя базы данных
POSTGRES_USER=postgres # логин для подключения к базе данных
POSTGRES_PASSWORD=password_postgres # пароль для подключения к БД (установите свой)
DB_HOST=db # название сервиса (контейнера)
DB_PORT=5432 # порт для подключения к БД
SECRET_KEY=django_secret_key # секретный ключ django (установите свой)
```
3. В командной строке перейдите в папку ./infra, запустите docker-compose в фоновом режиме командой:
```
docker-compose up -d
```
4. Примените миграции:
```
docker-compose exec backend python manage.py migrate
```
5. Чтобы зайти в админку создайте суперпользователя:
```
docker-compose exec backend python manage.py createsuperuser
```
Теперь проект доступен по адресу http://localhost/api/messages/
Админка доступна по адресу http://localhost/admin/
6. Чтобы протестировать работу приложения заполните БД тестовыми данными:
```
docker-compose exec backend python3 manage.py fill_database_with_test_data
```
## Curl
Файл с примерами запросов находится по адресу ./curl_commands, можно посмотреть по [ссылке](https://github.com/PavelPatsey/inside_test_task/blob/main/curl_commands). Должны быть установлены curl и jq, если нет:
```
apt install curl
apt install jq
```
## Endpoints:
### Аутентификация пользователя.
`http://localhost:8000/api/auth/token/`\
POST запрос с телом вида:
```json
{
"name": "имя отправителя",
"password": "пароль"
}
```
В случае удачной аутентификации возвращает JWT токен:
```json
{
"token": "xxxxx.xxxx.xxxx"
}
```
### Заголовок Authorization.
Формат заголовка "Authorization" должен быть таким:\
"Bearer_token"
### Отправка сообщения или запрос истории.
`http://localhost:8000/api/messages/`\
POST запрос с телом вида:
```json
{
"name": "имя отправителя",
"message": "новое сообщение"
}
```
В ответ получает:
```json
{
"name": "имя отправителя",
"message": "новое сообщение"
}
```
В случае, если отправлен POST запрос вида:
```json
{
"name": "user_name",
"message": "history n"
}
```
где n - целое неотрицательное число, возвращает последние n из БД.
Например, если n равно 5 в ответ получает:
```json
[
{"name": "имя отправителя", "message": "новое сообщение"},
{"name": "имя отправителя", "message": "test message text 14"},
{"name": "имя отправителя", "message": "test message text 13"},
{"name": "имя отправителя", "message": "test message text 12"},
{"name": "имя отправителя", "message": "test message text 11"},
]
```