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 та ін.)