OpenAPI- / Swagger-viser

Viser et OpenAPI 3.0 / 3.1- eller Swagger 2.0-dokument (YAML eller JSON) som en lesbar API-referanse — info, servere, merkede stier, parametere, eksempler på forespørselens innhold generert fra skjemaer, svar og sikkerhet. Utvid en operasjon for å bruke Prøv den og sende en direkte forespørsel fra nettleseren, eller eksporter den som cURL. Dokumentene tolkes lokalt; eksterne $ref-mål og eksterne skjemaer hentes ikke (helt lokalt). For en interaktiv forespørselskomponist, se REST API-klient / -tester og hele API-verktøyfamilien.
OpenAPI- / Swagger-dokument
Prøv
Parametere
Om denne visningen: støtter Swagger 2.0 og OpenAPI 3.0 / 3.1. Referanser løses bare inne i dokumentet (#/components/schemas/…, #/definitions/…); referanser til eksterne filer / URL-er rapporteres i stedet for å hentes. Prøv den-kall er underlagt målserverens CORS-regler — hvis et kall blokkeres, bruk cURL-omformer eller REST-klient for å kjøre det utenfor nettleserens sandkasse.
OpenAPI kontra Swagger, v2 kontra v3

Swagger var det opprinnelige verktøynavnet; da spesifikasjonsformatet ble gitt til Linux Foundation i 2015, ble det til OpenAPI, og Swagger lever videre som verktøymerke. Et dokument er bygd opp av info (metadata), paths (operasjoner per endepunkt) og components (gjenbrukbare skjemaer).

Versjonsnøkkelen forteller visningen hvilken tolker den skal bruke: swagger: "2.0" kontra openapi: 3.0.x — v3 flyttet forespørselsinnhold ut av parametere og tok i bruk ekte JSON Schema.