Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gitkodev/django_effective-team

Effective team test task
https://github.com/gitkodev/django_effective-team

Last synced: about 8 hours ago
JSON representation

Effective team test task

Awesome Lists containing this project

README

        

# 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
```