Pregledovalnik specifikacij OpenAPI

Vizualizirajte in preizkušajte dokumentacijo REST API iz specifikacij OpenAPI / Swagger (JSON ali YAML).

O orodju Pregledovalnik specifikacij OpenAPI — Podroben vodnik

Kategorija: DevOps in standardi 100 % lokalno v brskalniku

OpenAPI Viewer je bralnik dokumentacije na strani odjemalca za pregledovanje pogodb RESTful API. Upodablja specifikacije Swagger 2.0 in OpenAPI 3.0 / 3.1 v formatu JSON ali YAML brez potrebe po lokalni namestitvi Swagger UI ali odvisnostih v oblaku.

Ponuja pregledno skupinsko navigacijo v stranski vrstici za vse končne točke ter prikazuje poti, metode HTTP (GET, POST, PUT, DELETE), parametre glave, poizvedbene nize, strukturirana telesa zahtevkov, kode odgovorov HTTP in podatkovne sheme.

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

Ključne funkcije in zmogljivosti

  • Podpira specifikacije Swagger 2.0 in OpenAPI 3.0 / 3.1 v formatih JSON in YAML
  • Interaktivna stranska vrstica s kategoriziranimi končnimi točkami, metodami HTTP in statusnimi kodami
  • Globoko razreševanje shem `$ref` s prikazom vgnezdenih podatkovnih modelov in omejitev lastnosti
  • 100 % razčlenjevanje na strani odjemalca brez povezave, ki varuje lastniške pogodbe API podjetja

Kako uporabljati

  1. 1

    Prilepite besedilo datoteke `swagger.json` ali `openapi.yaml` ali neposredno naložite datoteko specifikacije.

  2. 2

    Prebrskajte strukturirano dokumentacijo API, prikazano v interaktivnem pregledovalniku.

  3. 3

    Razširite poljubno končno točko za ogled glav zahtevkov, shem koristne vsebine zahtevka in primerov odgovorov.

Pogosti primeri uporabe

  • → Pregledovanje definicij zalednih API-jev brez vzpostavitve namenskega strežnika Swagger UI
  • → Preverjanje veljavnosti ročno napisanih specifikacij OpenAPI za neveljavne kazalce `$ref`
  • → Zagotavljanje natančnih referenc shem za razvijalce ospredja med integracijo API-jev

Sorodna orodja

Pogosta vprašanja in zasebnost

Ali lahko to orodje neposredno bere specifikacije YAML?

Da. Vgrajeni razčlenjevalnik YAML obdela specifikacije pogodb OpenAPI tako v formatu `.yaml` kot `.json` povsem v brskalniku.

Ali se moja lastniška specifikacija API naloži na zunanje strežnike?

Ne. Celotno razčlenjevanje dokumentov in upodabljanje shem poteka izključno v pomnilniku vašega lokalnega brskalnika.