OpenAPI / Swagger -katselin

Renderöi OpenAPI 3.0 / 3.1 tai Swagger 2.0 -asiakirja (YAML tai JSON) selattavaksi API-viitteeksi — tiedot, palvelimet, tagatut polut, parametrit, skeemoista muodostetut pyynnön rungon esimerkit, vastaukset ja turvallisuus. Laajenna mikä tahansa operaatio Kokeile-toimintoon ja lähetä elävä pyyntö selaimesta, tai vie se cURL-muodossa. Asiakirjat jäsennetään paikallisesti; etäiset $ref-kohteet ja ulkoiset skeemat eivät ole haettavia (täysin paikallinen). Haluatko mieluummin interaktiivisen pyyntökokoajan? Katso REST API -asiakas / -testaaja ja koko API-työkalut -perhe.
OpenAPI- / Swagger-asiakirja
Kokeile
Parametrit
Tietoa tästä katselimesta: tukee Swagger 2.0- ja OpenAPI 3.0- / 3.1-muotoja. Viitteet ratkaistaan vain asiakirjan sisällä (#/components/schemas/…, #/definitions/…); ulkoisia tiedosto- tai URL-viitteitä ei haeta, vaan ne ilmoitetaan. Kokeile-kutsut ovat kohdepalvelimen CORS-käytännön alaisia — jos kutsu estetään, käytä cURL-muunninta tai REST-asiakasta ajaakseen sen selaimen hiekkalaatikon ulkopuolelta.
OpenAPI vs. Swagger, v2 vs. v3

Swagger oli alkuperäinen työkalunimi; kun määrittelymuoto lahjoitettiin Linux Foundationille vuonna 2015, siitä tuli OpenAPI, ja Swagger elää eteenpäin työkalujen brändinä. Asiakirja rakennetaan info-osasta (metatiedot), paths-osasta (operaatiot päätepistettä kohden) ja components-osasta (uudelleenkäytettävät skeemat).

Versioavain kertoo katselimille, mitä jäsenninta käytetään: swagger: "2.0" vs. openapi: 3.0.x — v3 siirsi pyynnön rungot parametreista ja otti käyttöön oikean JSON Schema -skeeman.