OpenAPI / Swagger Prohlížeč

Vykreslujte a testujte specifikace OpenAPI a Swagger (JSON / YAML) s interaktivní dokumentací.

O nástroji OpenAPI / Swagger Prohlížeč — Podrobný průvodce

Kategorie: DevOps a standardy 100 % lokálně v prohlížeči

OpenAPI Viewer je klientský prohlížeč dokumentace pro zkoumání kontraktů RESTful API. Vykresluje specifikace Swagger 2.0 a OpenAPI 3.0 / 3.1 ve formátu JSON nebo YAML, aniž by vyžadoval lokální instalaci Swagger UI nebo závislosti na cloudu.

Nabízí přehlednou seskupenou navigaci v postranním panelu pro všechny koncové body, kde zobrazuje cesty, HTTP metody (GET, POST, PUT, DELETE), parametry hlaviček, parametry dotazu (query strings), strukturovaná těla požadavků, HTTP stavové kódy odpovědí a datová schémata.

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

Klíčové funkce a možnosti

  • Podpora specifikací Swagger 2.0 a OpenAPI 3.0 / 3.1 ve formátech JSON a YAML
  • Interaktivní postranní panel se seznamem kategorizovaných koncových bodů, HTTP metod a stavových kódů
  • Hloubkové rozlišení schémat `$ref` zobrazující vnořené datové modely a omezení vlastností
  • 100% offline parsování na straně klienta chránící vaše proprietární podnikové API kontrakty

Jak nástroj používat

  1. 1

    Vložte text souboru `swagger.json` či `openapi.yaml`, nebo přímo nahrajte soubor se specifikací.

  2. 2

    Procházejte strukturovanou dokumentaci API vykreslenou v interaktivním prohlížeči.

  3. 3

    Rozbalte libovolný koncový bod pro kontrolu hlaviček požadavků, schémat těla požadavku a ukázek odpovědí.

Běžné scénáře použití

  • → Auditování definic backendových API bez nutnosti nasazovat vyhrazený server Swagger UI
  • → Kontrola správnosti ručně psaných specifikací OpenAPI a odhalení neplatných ukazatelů `$ref`
  • → Poskytnutí přesných referencí schémat frontendovým vývojářům během integrace API

Související nástroje

Časté dotazy a ochrana soukromí

Dokáže tento nástroj číst specifikace YAML přímo?

Ano. Integrovaný YAML parser zpracovává specifikace kontraktů OpenAPI ve formátech `.yaml` i `.json` zcela v prohlížeči.

Nahrává se má proprietární specifikace API na externí servery?

Ne. Veškeré parsování dokumentů a vykreslování schémat probíhá výhradně v paměti vašeho lokálního prohlížeče.