OpenAPI ve Swagger: API’leri belgelemek ve test etmek

Kısaca: OpenAPI bir REST arayüzünü YAML veya JSON ile makine tarafından okunabilir biçimde tanımlar; ondan belgeler, test araçları ve hatta hazır istemci kodu doğar.

Biraz daha ayrıntılı: Bir API sunan kişi hangi uç noktaların olduğunu, hangi parametreleri beklediğini ve ne döndürdüğünü söylemelidir. OpenAPI belirtimi (eski adıyla Swagger) bunun için standart bir biçim tanımlar. Swagger UI gibi araçlar…

Ayrıntılı

Örnek

openapi: 3.0.3
info:
  title: Task API

Ayrıca bak: REST API tasarımı, API sürümleme, Dosya biçimleri (YAML, JSON vb.)