API для библиотеки (1.0.0)

Download OpenAPI specification:Download

API для работы с базой данных библиотеки.
API позволяет получать:

  • список всех книг с их авторами,
  • информацию о конкретной книге,
  • список авторов,
  • список книг одного автора.
Также книги можно добавлять, удалять и редактировать о них сведения.

Получить список книг с авторами.

Возвращает массив книг. Каждая книга содержит: id, название, данные об авторе.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Добавить новую книгу.

Добавляет книгу в базу. Для добавления требуется ключ.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name_book
required
string
name_author
required
string
annotation
required
string

Responses

Request samples

Content type
application/json
{
  • "name_book": "Шекспир",
  • "name_author": "Ромео и Джульета",
  • "annotation": "Книга о любви"
}

Получить информацию о книге по id.

Возвращает объект с данными о книге по id. Объект содержит: id, название, данные об авторе, аннотацию.

path Parameters
id
required
integer

id книги.

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name_book": "Война и Мир",
  • "author": {
    },
  • "annotation": "События в книге происходят во время наполеоновских войн..."
}

Изменить данные о книге.

Изменяет данные о книге по id. Для изменения требуется ключ.

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

id книги.

Request Body schema: application/json
name_book
required
string
name_author
required
string
annotation
required
string

Responses

Request samples

Content type
application/json
{
  • "name_book": "Шекспир",
  • "name_author": "Ромео и Джульета",
  • "annotation": "Книга о любви"
}

Удалить книгу по id.

Удаляет книгу. Для удаления требуется ключ.

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

id книги.

Responses

Получить список авторов.

Возвращает список авторов. Каждый автор содержит: id, имя.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Получить список книг автора по его id.

Возвращает список книг. Книга содержит: id, название.

path Parameters
id
required
integer

id автора.

Responses

Response samples

Content type
application/json
[
  • {
    }
]