OpenAPI
OpenAPI to czytelny maszynowo schemat opisujący każdy endpoint, parametr i odpowiedź REST-owego API, z którego można wygenerować klienty.
Szczegółowo
To API publikuje dokument OpenAPI 3.1 obok indeksu llms.txt — dzięki temu generator SDK, kolekcja Postmana albo framework agentowy rozumieją jego powierzchnię, zanim ktokolwiek przeczyta prozę. To źródło prawdy o kształtach żądań i kodach statusu. Zmiany zachowania ogłaszamy w changelogu przed wdrożeniem, więc wygenerowanego klienta da się odświeżyć świadomie, zamiast odkryć go zepsutym.
Znane też jako
- swagger
- api schema