Спецификация OpenAPI¶

Общие сведения¶

API являются связующим звеном между современными приложениями. Почти каждое приложение использует API для связи с корпоративными источниками данных, сторонними службами данных или другими приложениями. Создание открытого формата описания для API-сервисов, независимого от производителя, портативного и открытого, имеет решающее значение для ускорения видения действительно связанного мира.

Спецификация OpenAPI (ранее Swagger Specification) - это формат описания API для API REST. Файл OpenAPI позволяет вам описать весь требуемый API, включая:

доступные конечные точки и операции на каждой конечной точке (GET, POST)
входные и выходные параметры для каждой операции
методы аутентификации
контактную информацию, лицензию, условия использования и другую информацию.

Спецификации API могут быть написаны в YAML или JSON. Формат прост в освоении и читаем как для людей, так и для машин.

Подробнее: