OpenAPI / Swagger Dokumentationsviser

Gennemse og forhåndsvis OpenAPI (Swagger 2.0 / 3.0) specifikationer i et interaktivt interface.

Om OpenAPI / Swagger Dokumentationsviser — Detaljeret vejledning

Kategori: DevOps og standarder 100 % lokalt i browseren

OpenAPI Viewer er en klientside-dokumentationslæser til inspektion af RESTful API-kontrakter. Den renderer Swagger 2.0- og OpenAPI 3.0 / 3.1-specifikationer i JSON eller YAML uden at kræve lokale Swagger UI-installationer eller cloud-afhængigheder.

Den præsenterer en overskuelig, grupperet sidepanelnavigation til alle endpoints og viser stier, HTTP-metoder (GET, POST, PUT, DELETE), header-parametre, query-strenge, strukturerede request bodies, HTTP-svarkoder og dataskemaer.

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

Nøglefunktioner og muligheder

  • Understøtter Swagger 2.0- og OpenAPI 3.0 / 3.1-specifikationer i JSON og YAML
  • Interaktivt sidepanel med kategoriserede endpoints, HTTP-metoder og statuskoder
  • Dybdegående `$ref`-skemaopløsning, der viser indlejrede datamodeller og egenskabsbegrænsninger
  • 100 % klientside offline-parsing, der holder fortrolige enterprise-API-kontrakter sikre

Sådan bruger du værktøjet

  1. 1

    Indsæt din `swagger.json`- eller `openapi.yaml`-tekst, eller upload specifikationsfilen direkte.

  2. 2

    Gennemse den strukturerede API-dokumentation, der renderes i den interaktive fremviser.

  3. 3

    Udvid et vilkårligt endpoint for at inspicere request headers, skemaer for anmodningsdata og svarprøver.

Almindelige anvendelser

  • → Gennemgang af backend-API-definitioner uden at skulle opsætte en dedikeret Swagger UI-server
  • → Sanity-tjek af håndskrevne OpenAPI-specifikationer for ugyldige `$ref`-referencer
  • → Levering af præcise skemareferencer til frontend-udviklere under API-integrationer

Relaterede værktøjer

Ofte stillede spørgsmål og privatliv

Kan dette værktøj læse YAML-specifikationer direkte?

Ja. En indbygget YAML-parser behandler både `.yaml`- og `.json`-OpenAPI-kontraktspecifikationer direkte i browseren.

Bliver min fortrolige API-specifikation uploadet til eksterne servere?

Nej. Al dokumentparsing og skemarendering udføres udelukkende i din lokale browsers hukommelse.