Swagger, resp. OpenAPI dokumentace

OpenAPI specifikace, dříve známá jako Swagger, je standardní formát pro popis RESTful API. Definuje jazykově neutrální rozhraní, které umožňuje objevování a popis API z hlediska svých koncových bodů (endpointů), vstupních/výstupních parametrů, autentizace, hlaviček a dalších detailů. Je to nástroj pro návrh, stavbu, dokumentaci a použití RESTful webových služeb, který je kompatibilní s různými technologiemi a platformami. Poslední verze OpenAPI je 3.0+. ABRA Web API je postavena na specifikaci swagger 2.0 , ale vzhledem k tomu, že OpenAPI je oficiální nástupce specifikace Swagger, budeme se držet termínu OpenAPI.

OpenAPI dokumentace je dostupná prostřednictvím endpointů: Tato dokumentace je především určena pro strojové zpracování, kdy aplikace pomocí API zjistí strukturu API a s ní pak nadále pracuje.

GET /{spojení}/api-docs

GET /{spojení}/api-docs/swagger.json

Podívejte se na návod použití OpenAPI dokumentace.

V OpenAPI dokumentaci naleznete:

• definice všech BO a zdrojů
• zdokumentované metody, které je možno na zdrojích použít
• aj.