Просмотреть API сервиса
Примечание
Спецификация OpenAPI описывает HTTP-API сервиса: эндпоинты, их параметры, тело запроса и ответы.
Открыть спецификацию#
Чтобы просмотреть API сервиса, выполните следующие действия:
- Откройте страницу сервиса (см. Найти документацию сервиса) и прокрутите до раздела OpenAPI.
- В разделе OpenAPI нажмите Спецификация. Откроется окно со списком эндпоинтов.
- В окне нажмите на нужный эндпоинт. Раскроются его параметры, тело запроса и ответы.
- Закройте окно крестиком в правом верхнем углу или клавишей Esc.
Примечание
Если раздела OpenAPI на странице сервиса нет, спецификация для него не описана.
Примечание
Окно только показывает спецификацию: отправить из него запрос к сервису нельзя.
Примечание
Кнопка Показать код в заголовке окна открывает исходный текст спецификации. Текст можно скопировать, но не изменить.
Примечание
У сервиса-контейнера раздел OpenAPI собирает спецификации его компонентов. Левая часть строки открывает спецификацию, правая часть от … ведёт на страницу компонента, которому она принадлежит.
Просмотреть логику эндпоинта#
Чтобы просмотреть логику эндпоинта, выполните следующие действия:
- В окне спецификации найдите эндпоинт и запомните его метод и путь (например, POST /orders).
- Закройте окно.
- На странице сервиса в разделе Логика в списке Операции нажмите на схему, рядом с которой указан этот эндпоинт. Откроется окно со схемой (см. Просмотреть логику операции или воркера).
Примечание
Если в списке Операции нет схемы с нужным эндпоинтом, логика этого эндпоинта не описана.