Podręcznik

Specyfikacja OpenAPI (ang. OpenAPI Specification, OAS) definiuje standardowy, niezależny od języka, sposób projektowania interfejsów API HTTP, który pozwala zarówno ludziom jak i komputerom odkrywać i rozumieć możliwości usługi bez dostępu do kodu źródłowego, dokumentacji lub poprzez inspekcję ruchu sieciowego. Po prawidłowym zdefiniowaniu konsument może zrozumieć i wchodzić w interakcje ze zdalną usługą przy minimalnej ilości logiki implementacji.

Definicja OpenAPI może być następnie wykorzystana przez narzędzia do generowania dokumentacji do wyświetlania API, narzędzia do generowania kodu do generowania serwerów i klientów w różnych językach programowania, narzędzia testujące i wiele innych przypadków użycia.

Formalna specyfikacja: https://swagger.io/specification/

Zapoznawanie się z OpenAPI Specification warto rozpocząć od artykułów zebranych na poniższych podstronach:

• Swagger Documentation
• API Design