OpenAPI / Swagger-megjelenítő

OpenAPI 3,0 / 3,1 vagy Swagger 2.0 dokumentum (YAML vagy JSON) böngészhető API-referenciává alakítása — információk, kiszolgálók, címkézett útvonalak, paraméterek, sémákból generált kérőtestpéldák, válaszok és biztonság. Bármely művelet kibontható a Kipróbálás gombbal, és élő kérés küldhető a böngészőből, vagy cURL-ként exportálható. A dokumentumok helyben kerülnek elemzésre; a távoli $ref célok és a külső sémák nem töltődnek le (teljesen helyi). Ha inkább interaktív kérésszerkesztő kell, erre ez a REST API-kliens / -tesztelő oldalt és az egész API-eszközök családot.
OpenAPI / Swagger-dokumentum
Kipróbálás
Paraméterek
A megjelenítőről: támogatja a Swagger 2.0-t és az OpenAPI 3.0 / 3.1-et. A hivatkozások csak a dokumentumon belül oldódnak fel (#/components/schemas/…, #/definitions/…); a külső fájl- vagy URL-hivatkozások jelentésre kerülnek, nem lekérésre. Kipróbálás hívásai a célkiszolgáló CORS-szabályzatának hatálya alá esnek — ha egy hívást blokkol, a cURL-átalakító vagy a REST Client használata javasolt, hogy a böngészőhomokozón kívülről fusson.
OpenAPI vs. Swagger, v2 vs. v3

A Swagger volt az eredeti eszköz neve; amikor 2015-ben a specifikációs formátumot a Linux Foundationnek adták, OpenAPI lett belőle, a Swagger pedig eszközmárkaként él tovább. Egy dokumentum info (metaadatok), paths (végpontonkénti műveletek) és components (újrafelhasználható sémák) részekből áll.

A verziókulcs jelzi a megjelenítőnek, melyik elemzőt használja: swagger: "2,0" kontra openapi: 3.0.x — a v3 a kérőtesteket kivette a paraméterek közül, és valódi JSON Schema-t vett át.