OpenAPI / Swagger Preglednik

Učitajte i pregledajte OpenAPI / Swagger specifikacije u interaktivnom korisničkom sučelju.

O alatu OpenAPI / Swagger Preglednik — Detaljni vodič

Kategorija: DevOps i standardi 100 % lokalno u pregledniku

OpenAPI Viewer je preglednik dokumentacije na strani klijenta za pregledavanje ugovora RESTful API-ja. Renderira specifikacije Swagger 2.0 i OpenAPI 3.0 / 3.1 u formatima JSON ili YAML bez potrebe za lokalnim instalacijama Swagger UI-ja ili ovisnostima o oblaku.

Pruža preglednu bočnu navigaciju s grupiranim krajnjim točkama, prikazujući staze, HTTP metode (GET, POST, PUT, DELETE), parametre zaglavlja, parametre upita, strukturirana tijela zahtjeva, HTTP statusne kodove odgovora i podatkovne sheme.

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

Ključne značajke i mogućnosti

  • Podržava specifikacije Swagger 2.0 i OpenAPI 3.0 / 3.1 u formatima JSON i YAML
  • Interaktivna bočna traka s kategoriziranim krajnjim točkama, HTTP metodama i statusnim kodovima
  • Dubinsko razrješavanje `$ref` shema s prikazom ugniježđenih podatkovnih modela i ograničenja svojstava
  • 100% parsiranje na strani klijenta izvan mreže, čime vlasnički API ugovori tvrtke ostaju sigurni

Kako koristiti

  1. 1

    Zalijepite tekst datoteke `swagger.json` ili `openapi.yaml`, ili izravno učitajte datoteku specifikacije.

  2. 2

    Pregledajte strukturiranu API dokumentaciju prikazanu u interaktivnom pregledniku.

  3. 3

    Proširite bilo koju krajnju točku kako biste pregledali zaglavlja zahtjeva, sheme korisnog tereta i primjere odgovora.

Uobičajeni slučajevi upotrebe

  • → Revizija definicija pozadinskih API-ja bez postavljanja zasebnog Swagger UI poslužitelja
  • → Provjera ispravnosti ručno pisanih OpenAPI specifikacija radi pronalaženja nevažećih `$ref` pokazivača
  • → Pružanje točnih referenci shema frontend inženjerima tijekom integracije API-ja

Povezani alati

Česta pitanja i privatnost

Može li ovaj alat izravno čitati YAML specifikacije?

Da. Ugrađeni YAML parser obrađuje i `.yaml` i `.json` specifikacije OpenAPI ugovora u potpunosti unutar preglednika.

Učitava li se moja vlasnička API specifikacija na vanjske poslužitelje?

Ne. Cjelokupno parsiranje dokumenta i renderiranje sheme odvija se isključivo unutar lokalne memorije vašeg preglednika.