petfood-api

0

Описание

Языки

  • Python98,6%
  • C++0,9%
  • C0,4%
  • Остальные0,1%
7 месяцев назад
6 месяцев назад
6 месяцев назад
7 месяцев назад
7 месяцев назад
6 месяцев назад
7 месяцев назад
6 месяцев назад
6 месяцев назад
README.md

PetFood API

Учебный проект для демонстрации принципов проектирования REST API: простота, стабильность, версионность, идемпотентность, ограничение частоты запросов, пагинация, опциональные поля, внутренние API и документация.

Документация: см. REPORT.md


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

1. Клонирование репозитория

2. Установка зависимостей

Рекомендуется использовать виртуальное окружение:

3. Запуск API

Сервер будет доступен по адресу:

4. Документация Swagger / ReDoc

5. Экспорт OpenAPI-спецификации


Структура проекта


Примеры запросов

Регистрация пользователя

Авторизация (получение JWT)

Создание заказа с идемпотентностью

Пагинация

Опциональные поля и include

Внутренний API