Editor de OpenAPI y Probador de Contratos
Solo localDiseña, valida, documenta, simula, genera código y compara contratos OpenAPI localmente.
openapi: 3.2.0
info:
title: Pocket Tasks API
version: 1.0.0
description: A compact example for designing and reviewing an API contract.
servers:
- url: https://api.example.com/v1
paths:
/tasks:
get:
operationId: listTasks
summary: List tasks
tags: [Tasks]
parameters:
- name: limit
in: query
schema:
type: integer
minimum: 1
maximum: 100
default: 20
responses:
"200":
description: Task collection
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Task"
post:
operationId: createTask
summary: Create a task
tags: [Tasks]
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/NewTask"
responses:
"201":
description: Task created
content:
application/json:
schema:
$ref: "#/components/schemas/Task"
/tasks/{taskId}:
get:
operationId: getTask
summary: Get a task
tags: [Tasks]
parameters:
- name: taskId
in: path
required: true
schema: { type: string, format: uuid }
responses:
"200":
description: Task found
content:
application/json:
schema:
$ref: "#/components/schemas/Task"
"404":
description: Task not found
components:
schemas:
NewTask:
type: object
required: [title]
properties:
title: { type: string, example: Ship the release }
done: { type: boolean, default: false }
Task:
allOf:
- $ref: "#/components/schemas/NewTask"
- type: object
required: [id]
properties:
id: { type: string, format: uuid }
createdAt: { type: string, format: date-time }
Cómo usarla
- 01
Abrir un contrato
Pegar o importar un documento OpenAPI YAML o JSON, cambiar formatos y ejecutar diagnósticos estructurales y de referencia.
- 02
Explorar y probar el diseño
Busque operaciones, parámetros y respuestas, genere cargas útiles simuladas basadas en esquemas y copie ejemplos de cURL, Fetch o Python.
- 03
Revisión de la compatibilidad
Compare un contrato candidato con la versión actual e identifique las operaciones eliminadas, las respuestas y los parámetros recién requeridos antes de su lanzamiento.
Preguntas frecuentes
¿Qué versiones de OpenAPI son compatibles?
La herramienta reconoce estructuras OpenAPI 3.0, 3.1 y 3.2. Swagger 2.0 se puede inspeccionar con un aviso de migración.
¿Llama a mi API o busca referencias externas?
No. Código y cargas útiles simuladas se generan localmente. URLs externas de $ref se informan, pero nunca se obtienen automáticamente.
¿Es un validador de conformidad oficial completo?
No. Proporciona estructuras prácticas, operación, parámetro de ruta, respuesta y comprobaciones de referencia. La especificación OpenAPI sigue siendo autorizada.
¿La diferencia prueba la compatibilidad hacia atrás?
No. Señala cambios estructurales de alto valor de forma conservadora; la compatibilidad con la producción también depende de esquemas, semántica, clientes, seguridad y pruebas de tiempo de ejecución.
Herramientas relacionadas
Continúa con otras utilidades web específicas.