API Markdown 文档, источник TRR

TOC каталог

• [App\api\controller\auth: Схемы авторизации](#app\api\controller\auth: схемы авторизации)

  • [Create: Создание авторизации](#create: создание авторизации)
  • [Refresh: Обновление авторизации](#refresh: обновление авторизации)

• [App\api\controller\v1\book: Класс книг](#app\api\controller\v1\book: класс книг)

  • [Create: Создание книги](#create: создание книги)

API содержание

[App\api\controller\auth: Схемы авторизации](#app\api\controller\auth: схемы авторизации)

Create: Создание авторизации

• url: /auth
• method: post
• params: Запрос параметров документа | Параметр | Описание | Обязательное | По умолчанию | |:----:|:----:|:----:|:----:| | password | Пароль | Да | Нет | | name | Имя | Да | Нет |
• success: Пример успешного возврата

{"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJUUlIiLCJpYXQiOjE1NjQwNDc4ODcsImV4cCI6MTU2NDA1NTA4NywidXVpZCI6MTAwLCJzaWduYXR1cmUiOiIxMiJ9.QAvjERUOvQ2QwUcPnQOJuYGuTDgzWCZ7gaNziJHDmVI", "refresh_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJUUlIiLCJpYXQiOjE1NjQwNDc4ODcsInV1aWQiOjEwMCwic2lnbmF0dXJlIjoiMTIifQ.n-TZSFr9NqaTIjWpxR3ZUeP7WobYrhYvS5lIVkxRaIM"}

• error: Пример ошибки возврата

{"code": 3000, "message": "3000: ошибка содержимого . параметр проверки . имя не может быть пустым, пароль не может быть пустым", "request_url": "auth"}

Refresh: Обновление авторизации

• url: /auth/refresh
• method: get
• params: Документ запроса параметров | Параметр | Описание | Обязательное | По умолчанию | |:----:|:----:|:----:|:----:|
• success: Пример успешного возврата

{ "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJUUlIiLCJpYXQiOjE1NjQxMDY2ODAsImV4cCI6MTU2NDExMzg4MCwidXVpZCI6MTAwLCJzaWduYXR1cmUiOiIyMyJ9.1Te9jeAQVvj6VbgiVEk1-CChn8KybpOXqiyH8a4UB68"}

• error: Пример ошибки возврата

{ "code": 3000, "message": "3000: ошибка содержимого . 1000: ошибка содержимого . запрос header не содержит информацию авторизации", "request_url": "auth/refresh"}

[App\api\controller\v1\book: Класс книг](#app\api\controller\v1\book: класс книг)

Create: Создание книги

• url: /v1/book
• method: get
• params: Документ запроса параметров | Параметр | Описание | Обязательное | По умолчанию | |:----:|:----:|:----:|:----:| | img | Изображение книги | Да | Нет | | name | Название книги | Да | Нет |
• success: Пример успешного возврата

• error: Пример ошибки возврата

Спасибо за использование TRR! Желаю вам счастливой жизни!