Swagger / OpenAPI

Visualiza documentos OpenAPI 3 y Swagger 2 (YAML o JSON) sin enviarlos a ningún servidor.

Se procesa en tu navegador · Compruébalo Sin envíosDatos enviados: 0 · A otros dominios: 0Analítica: no existe · Anuncios: no existe

Prueba un ejemplo

Especificación (YAML o JSON)

O abre un fichero:

No se hace ninguna petición de red: el documento se procesa en tu navegador.

Aprende

¿Qué es?

OpenAPI (antes Swagger) es un formato para describir una API REST en un único fichero YAML o JSON. Dice qué rutas existen, qué parámetros aceptan y qué respuestas devuelven. Este visor lo convierte en una página navegable.

¿Para qué sirve?

Entender una API que no conoces sin leer el código.
Revisar un contrato antes de implementarlo o consumirlo.
Detectar errores en el documento: referencias rotas, operationId repetidos, parámetros de ruta sin declarar.

¿Cómo funciona por dentro?

El documento tiene paths (las rutas) y, por cada una, las operaciones por método (get, post…). Cada operación declara parámetros, un cuerpo opcional (requestBody) y respuestas por código de estado. Para no repetirse, usa $ref y apunta a components/schemas. El visor resuelve esas referencias y detecta las circulares para no entrar en un bucle.

Errores comunes

Confundir required de un campo con que su valor no pueda ser null (nullable): son cosas distintas.
Olvidar declarar un parámetro de ruta ({id}) en la operación.
Copiar sólo un trozo del documento: sin openapi: o swagger: en la raíz no se reconoce.
Documentos con $ref a ficheros externos: por privacidad este visor no descarga nada; pega el documento ya combinado.

Glosario

OpenAPI:: Estándar para describir APIs REST en YAML o JSON; es el sucesor de Swagger 2.0.
Endpoint:: Una combinación de método HTTP y ruta, como GET /pets.
Esquema (schema):: La forma de los datos: qué campos tiene y de qué tipo.
$ref:: Una referencia a otra parte del documento para no repetir definiciones.
operationId:: Nombre único de una operación; los generadores de código lo usan como nombre de función.

Para saber más

Más en APIs

Analizador de User-Agent

Aprende paso a paso en la rutaFormatos de datos y APIs