OpenAPI / Swagger -katselin

Tarkastele ja testaa OpenAPI 3.0 / Swagger -määrityksiä interaktiivisella dokumentaatiolla.

Tietoja: OpenAPI / Swagger -katselin — Yksityiskohtainen opas

Kategoria: DevOps ja standardit 100 % paikallisesti selaimessa

OpenAPI Viewer on asiakaspuolella toimiva dokumentaatiolukija RESTful API -kuvausten tarkasteluun. Se renderöi Swagger 2.0- ja OpenAPI 3.0 / 3.1 -määritykset JSON- tai YAML-muodossa ilman paikallista Swagger UI -asennusta tai pilviriippuvuuksia.

Se tarjoaa selkeän, ryhmitellyn sivupalkkinavigaation kaikille päätepisteille ja näyttää polut, HTTP-metodit (GET, POST, PUT, DELETE), otsikkoparametrit, kyselymerkkijonot (query strings), jäsennellyt pyynnön rungot, HTTP-tilakoodit ja datascheemat.

#openapi #swagger #api #docs #rest #yaml #json

Keskeiset ominaisuudet ja toiminnot

  • Tukee Swagger 2.0- ja OpenAPI 3.0 / 3.1 -määrityksiä JSON- ja YAML-muodoissa
  • Vuorovaikutteinen sivupalkki, joka luetteloi luokitellut päätepisteet, HTTP-metodit ja tilakoodit
  • Syvällinen `$ref`-viittausten purku, joka näyttää sisäkkäiset datamallit ja ominaisuuksien rajoitteet
  • 100-prosenttinen asiakaspuolen offline-jäsennys, joka pitää yrityksen sisäiset API-sopimukset turvassa

Käyttöohjeet

  1. 1

    Liitä `swagger.json`- tai `openapi.yaml`-teksti tai tuo määritystiedosto suoraan.

  2. 2

    Selaa vuorovaikutteisessa katselimessa renderöityä jäsenneltyä API-dokumentaatiota.

  3. 3

    Laajenna mikä tahansa päätepiste tarkastellaksesi pyynnön otsikoita, hyötykuorman scheemoja ja vastausesimerkkejä.

Yleiset käyttökohteet

  • → Taustajärjestelmän API-määritysten auditointi ilman erillisen Swagger UI -palvelimen käyttöönottoa
  • → Käsin kirjoitettujen OpenAPI-määritysten tarkistaminen virheellisten `$ref`-osoittimien varalta
  • → Tarkkojen scheemaviitteiden tarjoaminen frontend-kehittäjille API-integraatioiden aikana

Vastaavat työkalut

Usein kysytyt kysymykset ja tietosuoja

Voiko tämä työkalu lukea YAML-määrityksiä suoraan?

Kyllä. Sisäänrakennettu YAML-jäsennin käsittelee sekä `.yaml`- että `.json`-muotoiset OpenAPI-sopimusmääritykset kokonaan selaimessa.

Ladataanko suojatut API-määritykseni ulkoisille palvelimille?

Ei. Kaikki dokumenttien jäsennys ja scheemojen renderöinti suoritetaan ainoastaan paikallisesti selaimesi muistissa.