Skip to content

Repository files navigation

Асинхронный Web-сервис получения вопросов викторин


Используемый стек

Python FastAPI Docker Postgres

Системные требования

  • Python 3.11+;
  • Docker (19.03.0+) c docker compose;
  • Poetry.

Подготовка проекта к запуску

Заполнить .env-файл, вариант заполнения указан example.env.

Запуск проекта

1. Из корневой папки запустить docker-compose командой:

docker-compose up

или для пересборки

docker-compose up -d --build

Миграции alembic будут применены автоматически.

Техническая документация

Доступ к Swagger:

http://127.0.0.1/docs/

Как работать с API сервиса

Пользователь отправляет POST-запрос с параметром questions_num в котором указывает количество вопросов на эндпоинт /api/questions/, в ответе на запрос ему приходит список сохраненных в базе данных вопросов викторины

Пример:

POST localhost/api/questions/
Content-Type: application/json

{
  "questions_num": 1
}

В случае отсутвия вопросов в базе данных возвращается пустой список.

About

Асинронный Web-сервис получения вопросов викторины

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages