OpenAPI / Swagger-dokumentviser

Forhåndsvis og utforsk OpenAPI 3.0- og Swagger-spesifikasjonsfiler interaktivt.

Om OpenAPI / Swagger-dokumentviser — Detaljert veiledning

Kategori: DevOps og standarder 100 % lokalt i nettleseren

OpenAPI Viewer er en klientsidig dokumentasjonsleser for inspeksjon av RESTful API-kontrakter. Den gjengir Swagger 2.0- og OpenAPI 3.0 / 3.1-spesifikasjoner i JSON eller YAML uten å kreve lokale Swagger UI-installasjoner eller skyavhengigheter.

Den tilbyr en ryddig og gruppert sidefeltnavigasjon for alle endepunkter, med visning av stier, HTTP-metoder (GET, POST, PUT, DELETE), header-parametere, spørrestrenger (query strings), strukturerte forespørselskropper (request bodies), HTTP-svarkoder og dataskjemaer.

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

Nøkkelfunksjoner og muligheter

  • Støtter Swagger 2.0- og OpenAPI 3.0 / 3.1-spesifikasjoner i JSON og YAML
  • Interaktivt sidefelt som viser kategoriserte endepunkter, HTTP-metoder og statuskoder
  • Dyp `$ref`-skjemaoppløsning som viser nøstede datamodeller og egenskapsbegrensninger
  • 100 % klientsidig offline-parsing som holder proprietære bedrifts-API-kontrakter trygge

Slik bruker du verktøyet

  1. 1

    Lim inn teksten fra `swagger.json` eller `openapi.yaml`, eller last opp spesifikasjonsfilen direkte.

  2. 2

    Bla gjennom den strukturerte API-dokumentasjonen som gjengis i den interaktive visningen.

  3. 3

    Utvid et hvilket som helst endepunkt for å inspisere forespørselshoder (request headers), forespørselsnyttelastskjemaer og svarseksempler.

Vanlige bruksområder

  • → Revisjon og inspeksjon av backend-API-definisjoner uten å sette opp en dedikert Swagger UI-server
  • → Rimelighetssjekk av håndskrevne OpenAPI-spesifikasjoner for ugyldige `$ref`-pekere
  • → Gi frontend-utviklere nøyaktige skjemareferanser under API-integrasjoner

Relaterte verktøy

Ofte stilte spørsmål og personvern

Kan dette verktøyet lese YAML-spesifikasjoner direkte?

Ja. En innebygd YAML-parser behandler både `.yaml`- og `.json`-OpenAPI-kontraktspesifikasjoner fullstendig i nettleseren.

Blir den proprietære API-spesifikasjonen min lastet opp til eksterne servere?

Nei. All dokumentparsing og skjemagjengivelse kjøres utelukkende i nettleserens lokale minne.