Skip to content

Latest commit

 

History

History
48 lines (34 loc) · 2.37 KB

README.md

File metadata and controls

48 lines (34 loc) · 2.37 KB

Effective team REST API

Rest API с использованием Django и Django Rest Framework

Сущности

  1. Creator
  2. Team
  3. Member
  4. Request
  5. Transaction

Endpoints

CRUD операции

  • /api/имя_сущности/   =>   POST   =>   Добавить сущность (creator/team/member/request)
  • /api/имя_сущности/   =>   GET   =>   Получить все сущности (creator/team/member/request)
  • /api/имя_сущности/id/   =>   GET   =>   Получить сущность по id (creator/team/member/request)
  • /api/имя_сущности/id/   =>   PUT   =>   Обновить сущность (creator/team/member/request)
  • /api/имя_сущности/id/   =>   DELETE   =>   Удалить сущность (creator/team/member/request)

Операции с транзакциями

  • /api/transactions/   =>   GET   =>   Получить все транзакции
  • /api/transactions/   =>   POST   =>   Осуществить транзакцию

Операции с запросами на вступленние в комманды

  • /api/teams/id/request   =>   GET   =>   Получить все запросы в команду
  • /api/teams/id/request   =>   POST   =>   Отправить запрос в команду
  • /api/teams/id/recruit   =>   POST   =>   Принять в команду участников (отбор по выносливости в случае ограниченного количества мест в групппе)

Swagger документация по доступным эндпоинтам

  • /api/schema/swagger-ui/   =>   GET  
  • /api/schema/redoc/   =>   GET  

Запуск

Первоначальный запуск для установки всех небходимых зависимостей и миграций

make initUp

Повторный запуск

make up