diff --git a/docs/api.md b/docs/api.md index a2a1061c..21977149 100644 --- a/docs/api.md +++ b/docs/api.md @@ -1,20 +1,14 @@ # REST API ## Авторизация -HTTP заголовок: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9 -Токен возвращается в ответ на `/auth` +HTTP заголовок: Authorization: Token eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9 +Токен возвращается в ответ на `/api/v1/api-token-auth/` ## Статус коды ответов -Успех: 2ХХ Ошибка сервера: 5ХХ Ошибка входящего запроса (включая ошибки бизнес-логики): 4ХХ В ответе возвращается тип ошибки {"error": "E_VALIDATION"} - -## Общие ошибки: - -* E_VALIDATION Ошибка входящих параметров -* E_SESSION_EXPIRED Сессия истекла, пользователя нужно направить на форму авторизации -* E_TOKEN Неправильно сформирован токен -* E_AUTH Неправильный логин или пароль -* E_NOT_FOUND Сущность не найдена -* E_ACCESS Не достаточно прав для просмотра +Успех: 2ХХ +Ошибка сервера: 5ХХ +Ошибка входящего запроса (включая ошибки бизнес-логики): 4ХХ +В ответе возвращается тип ошибки {"error": "ERROR_DESCRIPTION", code=HTTP_STATUS_CODE} ## Формат ответа Ответ от сервера возвращается в JSON. Значение null описывает не установленное значение имеющегося поле. В UI должно выводиться как «Не установлено», прочерк и тп, в инпутах каститься в пустую строку @@ -30,8 +24,8 @@ HTTP заголовок: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXV ## CRUD endpoints Каждая из сущностей, представленных ниже, имеет стандартные точки доступа: -* `GET /entity` Получить список всех сущностей -* `POST /entity` Добавить новую сущность +* `GET /entity/` Получить список всех сущностей +* `POST /entity/` Добавить новую сущность * `GET /entity/:id` Получить подробную информацию о сущности * `PUT /entity/:id` Обновить информацию * `DELETE /entity/:id` Удалить сущность @@ -43,12 +37,12 @@ HTTP заголовок: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXV Управление курсами ### Lesson -Управление уроками курсов. Является вложенной сущностью от Course +Управление уроками курсов. -### Payment, AuthorBalance +### Payment(CoursePayment, SchoolPayment), AuthorBalance Получение информации об оплатах и управление запросами на вывод -### Comment +### Comment (CourseComment, LessonComment) Управление комментариями(модерирование) ### Category @@ -58,4 +52,4 @@ HTTP заголовок: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXV Управление подписками и рассылками пользователям -_Форматы запросов и ответов будут подробно описываться с помощью автоматической документации Swagger Documentation Generator for Django REST Framework_ \ No newline at end of file +_Форматы запросов и ответов будут подробно описываться с помощью автоматической документации Swagger Documentation Generator for Django REST Framework_