Шаблон документации API для JSON-RPC и образец заполнения

Ниже приведен пример заполнения документации API для протокола JSON-RPC. Шаблон документа доступен для скачивания тут.

getBanners

Метод для получение списка баннеров. Можно получить баннеры указанной категории и с указанным типом видимости баннера для пользователей.

Аутентификация

Для доступа к API требуется аутентификация. Используйте Bearer Token для аутентификации всех запросов. Токен передается в заголовке `Authorization`.

Общие сведения о контракте

Параметры запроса (params)

Формат успешного ответа (​​result)

Обрабатываемые ошибки (error)

Пример запроса и ответа

Запрос

{
    «jsonrpc»:«2.0»,
    «id»: «1»,
    «method»:«getBanners»,
    «params»: {
        «bannerCategory»: «Категория 1»,
        «isVisible»: true
    }
}

Успешный ответ

{
    «jsonrpc»: «2.0», 
    «id»: «1»,
    «result»: [
        {
              «id»: 1,
              «title»: «Заголовок баннера»,
              «mainText»: «Основной текст баннера»,
              «image»: «https://example.com/banners/banner1.jpg»,
              «bannerCategory»: «Категория 1»,
              «isVisible»: true,
              «link»: «https://example.com/banners/banner1»
       }
    ]
}

Ответ с ошибкой

{
    «jsonrpc»: «2.0», 
    «id»: «1»,
    «error»: {
        «code»: -32600, 
        «message»: «Invalid Request»
    }
}

Сопоставление параметров метода с базой данных

Параметры запроса

Параметры ответа

Другие шаблоны

Шаблон документации для API REST и пример заполнения опубликованы тут

Может быть у вас есть примеры шаблонов получше?