API

Раздел интерфейса с информацией об API сервиса.

В EDP реализована возможность визуализации спецификации API, доступ к которой осуществляется различными способами.

1. В репозитории сервиса. Поддерживается возможность визуализации разных версий спецификации API для разных веток репозитория.

2. По ссылке. Поддерживается возможность добавить ссылку на спецификацию swagger для разных окружений. Ссылки добавляется путем обновления сервиса. Подробнее.

Файл с описанием спецификации API должен называться openapi-schema.yml, иметь совместимый со Swagger формат: swagger: "2.0" или openapi: 3.x.y, и находиться в корне репозитория сервиса в соответствующей ветке.

API визуализируется в Read Only режиме. Это означает, что возможность сделать тестовый API запрос ("Try it out") через интерфейс EDP отсутствует.

Интерфейс панели "API":