OpenAPI / Swagger skatītājs

Priekšskatiet un testējiet OpenAPI 3.0 un Swagger 2.0 API specifikācijas interaktīvā saskarnē.

Par OpenAPI / Swagger skatītājs — Detalizēta rokasgrāmata

Kategorija: DevOps un standarti 100% lokāli pārlūkprogrammā

OpenAPI Viewer ir klienta puses dokumentācijas lasītājs RESTful API līgumu pārbaudei. Tas renderē Swagger 2.0 un OpenAPI 3.0 / 3.1 specifikācijas JSON vai YAML formātā, neprasot lokālu Swagger UI instalāciju vai mākoņa atkarības.

Tas nodrošina pārskatāmu, grupētu sānu joslas navigāciju visiem galapunktiem, attēlojot ceļus, HTTP metodes (GET, POST, PUT, DELETE), galvenes parametrus, vaicājuma virknes, strukturētus pieprasījumu pamattekstus, HTTP atbilžu kodus un datu shēmas.

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

Galvenās funkcijas un iespējas

  • Atbalsta Swagger 2.0 un OpenAPI 3.0 / 3.1 specifikācijas JSON un YAML formātos
  • Interaktīva sānu josla ar kategorizētiem galapunktiem, HTTP metodēm un statusa kodiem
  • Dziļa `$ref` shēmu atrisināšana, attēlojot iegultos datu modeļus un īpašību ierobežojumus
  • 100% bezsaistes parsēšana klienta pusē, garantējot uzņēmuma patentēto API līgumu drošību

Kā lietot

  1. 1

    Ielīmējiet savu `swagger.json` vai `openapi.yaml` tekstu vai augšupielādējiet specifikācijas failu tieši.

  2. 2

    Pārlūkojiet strukturēto API dokumentāciju, kas renderēta interaktīvajā skatītājā.

  3. 3

    Izvērsiet jebkuru galapunktu, lai pārbaudītu pieprasījuma galvenes, pieprasījuma datu slodzes shēmas un atbilžu paraugus.

Biežākie lietošanas gadījumi

  • → Aizmugursistēmas API definīciju audits bez nepieciešamības uzturēt atsevišķu Swagger UI serveri
  • → Ar roku rakstītu OpenAPI specifikāciju pārbaude, meklējot nederīgas `$ref` norādes
  • → Precīzu shēmu atsauču nodrošināšana priekšgala izstrādātājiem API integrāciju laikā

Saistītie rīki

Biežāk uzdotie jautājumi un privātums

Vai šis rīks var tieši nolasīt YAML specifikācijas?

Jā. Iebūvētais YAML parsētājs apstrādā gan `.yaml`, gan `.json` OpenAPI līgumu specifikācijas pilnībā pārlūkprogrammā.

Vai mana patentētā API specifikācija tiek augšupielādēta ārējos serveros?

Nē. Visa dokumentu parsēšana un shēmu renderēšana notiek tikai jūsu vietējās pārlūkprogrammas atmiņā.