Update api doc

remotes/origin/hasaccess
Ivlev Denis 8 years ago
parent 231a2a2759
commit 7844835bde
  1. 28
      docs/api.md

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

Loading…
Cancel
Save