Visor d'especificacions OpenAPI / Swagger

Renderitza i explora documents de documentació d'API Swagger/OpenAPI en formats YAML i JSON.

Quant a Visor d'especificacions OpenAPI / Swagger — Guia detallada

Categoria: DevOps i estàndards 100 % local al navegador

L'OpenAPI Viewer és un lector de documentació del costat del client per inspeccionar contractes d'API RESTful. Renderitza especificacions Swagger 2.0 i OpenAPI 3.0 / 3.1 en JSON o YAML sense necessitat d'instal·lacions locals de Swagger UI ni dependències al núvol.

Presenta una navegació lateral agrupada i neta per a tots els endpoints, mostrant rutes, mètodes HTTP (GET, POST, PUT, DELETE), paràmetres de capçalera, cadenes de consulta (query strings), cossos de sol·licitud estructurats, codis de resposta HTTP i esquemes de dades.

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

Funcions i capacitats clau

  • Compatible amb especificacions Swagger 2.0 i OpenAPI 3.0 / 3.1 en JSON i YAML
  • Barra lateral interactiva que llista endpoints categoritzats, mètodes HTTP i codis d'estat
  • Resolució profunda d'esquemes `$ref` que mostra models de dades niats i restriccions de propietats
  • Anàlisi 100% fora de línia al costat del client que manté segurs els contractes d'API propietaris de l'empresa

Com utilitzar-ho

  1. 1

    Enganxeu el text de `swagger.json` o `openapi.yaml`, o bé pugeu directament el fitxer d'especificació.

  2. 2

    Exploreu la documentació estructurada de l'API renderitzada al visualitzador interactiu.

  3. 3

    Desplegueu qualsevol endpoint per inspeccionar les capçaleres de sol·licitud, els esquemes de càrrega útil de la sol·licitud i les mostres de resposta.

Casos d’ús habituals

  • → Auditoria de definicions d'API de backend sense haver de desplegar un servidor Swagger UI dedicat
  • → Comprovació de coherència d'especificacions OpenAPI escrites a mà per detectar punters `$ref` no vàlids
  • → Proporcionar als enginyers de frontend referències d'esquema precises durant les integracions d'API

Eines relacionades

Preguntes freqüents i privadesa

Aquesta eina pot llegir especificacions YAML directament?

Sí. Un analitzador YAML integrat processa completament al navegador especificacions de contractes OpenAPI tant en format `.yaml` com `.json`.

La meva especificació d'API propietària es puja a servidors externs?

No. Tota l'anàlisi de documents i la renderització d'esquemes s'executen estrictament a la memòria local del vostre navegador.