Prehliadač špecifikácií OpenAPI / Swagger

Prezerajte a testujte interaktívnu dokumentáciu rozhraní API vo formátoch OpenAPI 3.0 a Swagger 2.0.

O nástroji Prehliadač špecifikácií OpenAPI / Swagger — Podrobný sprievodca

Kategória: DevOps a štandardy 100 % lokálne v prehliadači

OpenAPI Viewer je prehliadač dokumentácie na strane klienta určený na kontrolu kontraktov RESTful API. Vykresľuje špecifikácie Swagger 2.0 a OpenAPI 3.0 / 3.1 vo formátoch JSON alebo YAML bez nutnosti lokálnej inštalácie Swagger UI či cloudových závislostí.

Ponúka prehľadnú zoskupenú navigáciu v bočnom paneli pre všetky koncové body, pričom zobrazuje cesty, metódy HTTP (GET, POST, PUT, DELETE), parametre hlavičiek, reťazce dopytov (query strings), štruktúrované telá požiadaviek, stavové kódy HTTP a dátové schémy.

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

Kľúčové funkcie a možnosti

  • Podpora špecifikácií Swagger 2.0 a OpenAPI 3.0 / 3.1 vo formátoch JSON a YAML
  • Interaktívny bočný panel so zoznamom kategorizovaných koncových bodov, metód HTTP a stavových kódov
  • Hĺbkové rozlišovanie schém pomocou `$ref` zobrazujúce vnorené dátové modely a obmedzenia vlastností
  • 100 % offline parsovanie na strane klienta, ktoré udržiava proprietárne podnikové API kontrakty v bezpečí

Ako používať

  1. 1

    Vložte text `swagger.json` alebo `openapi.yaml`, prípadne súbor špecifikácie priamo nahrajte.

  2. 2

    Prehliadajte štruktúrovanú dokumentáciu API vykreslenú v interaktívnom prehliadači.

  3. 3

    Rozbaľte ľubovoľný koncový bod a skontrolujte hlavičky požiadaviek, schémy tiel požiadaviek a ukážky odpovedí.

Bežné scenáre použitia

  • → Auditovanie definícií backendových API bez nutnosti prevádzkovať vyhradený server Swagger UI
  • → Základná kontrola ručne písaných špecifikácií OpenAPI na neplatné ukazovatele `$ref`
  • → Poskytnutie presných referencií schém frontendovým vývojárom počas integrácie API

Súvisiace nástroje

Časté otázky a ochrana súkromia

Dokáže tento nástroj priamo čítať špecifikácie YAML?

Áno. Vstavaný parser YAML spracováva zmluvné špecifikácie OpenAPI vo formátoch `.yaml` aj `.json` úplne priamo v prehliadači.

Nahráva sa moja proprietárna špecifikácia API na externé servery?

Nie. Všetko parsovanie dokumentov a vykresľovanie schém prebieha výlučne v pamäti vášho lokálneho prehliadača.