OpenAPI и Swagger: документирование и тестирование API

Коротко: OpenAPI описывает REST-интерфейс в машиночитаемом виде в YAML или JSON; из него возникают документация, инструменты тестирования и даже готовый клиентский код.

Подробнее: Кто предлагает API, должен сказать, какие конечные точки существуют, какие параметры они ожидают и что возвращают. Спецификация OpenAPI (прежде Swagger) определяет для этого стандартный формат. Инструменты вроде Swagger UI…

Подробности

Пример

openapi: 3.0.3
info:
  title: Task API

См. также: проектирование REST API, версионирование API, форматы файлов (YAML, JSON и др.)