Validador de contrato de respuesta API

Valida un JSON de respuesta real contra el schema de respuesta declarado en OpenAPI 3.x

Pega un documento OpenAPI 3.x y una respuesta real, luego indica path, method y status code. La herramienta resuelve el schema de respuesta y destaca campos faltantes, tipos incorrectos, enums invalidos y campos no documentados.

Como usar:

  • Spec OpenAPI: pega YAML o JSON
  • JSON de respuesta: pega la carga real
  • Ruta / Metodo / Codigo de estado: identifica la operacion y respuesta
  • Formato del spec: usa auto si no estas seguro
  • Prohibir campos extra: avisa cuando aparezcan campos no descritos

Resultados de ejemplo

1 Ejemplos

Comprobar si la respuesta real sigue el schema de usuario

Valida una respuesta real contra OpenAPI y detecta campos faltantes o tipos incorrectos.

Contract validation issues
Ver parámetros de entrada
{ "openApiSpec": "openapi: 3.0.3\npaths:\n /users/{id}:\n get:\n responses:\n \"200\":\n description: ok\n content:\n application/json:\n schema:\n type: object\n required: [id, name]\n properties:\n id: { type: integer }\n name: { type: string }\n active: { type: boolean }", "responseJson": "{\"id\":\"1\",\"active\":\"yes\"}", "path": "/users/42", "method": "get", "statusCode": "200", "specFormat": "yaml", "disallowAdditionalProperties": true }

Datos clave

Categoría
Desarrollo y Web
Tipos de entrada
textarea, text, select, checkbox
Tipo de salida
html
Cobertura de muestras
4
API disponible
Yes

Resumen

El Validador de contrato de respuesta API es una herramienta diseñada para comprobar si un JSON de respuesta real cumple estrictamente con el esquema definido en tu especificación OpenAPI 3.x. Simplemente pega tu documento OpenAPI y el payload de respuesta, indica la ruta, el método HTTP y el código de estado, y la herramienta detectará automáticamente campos faltantes, errores de tipo de datos, enumeraciones inválidas y propiedades no documentadas.

Cuándo usarlo

  • •Durante el desarrollo y pruebas de APIs para asegurar que el backend devuelve exactamente lo que promete la documentación oficial.
  • •Al depurar problemas de integración entre el frontend y el backend causados por cambios inesperados en la estructura de los datos.
  • •Para auditar respuestas de producción y garantizar el cumplimiento estricto del contrato OpenAPI antes de un lanzamiento.

Cómo funciona

  • •Pega tu especificación OpenAPI 3.x (en formato YAML o JSON) y el JSON de la respuesta real que deseas validar.
  • •Define la ruta (path), el método HTTP (GET, POST, etc.) y el código de estado (ej. 200) para localizar el esquema exacto en tu documento.
  • •Opcionalmente, activa la opción de prohibir campos extra para detectar propiedades que no estén declaradas en el contrato.
  • •La herramienta analiza los datos y genera un reporte detallado destacando campos faltantes, tipos de datos incorrectos o valores inválidos.

Casos de uso

Validación de contratos impulsada por el consumidor (Consumer-Driven Contract Testing) para evitar rupturas en clientes móviles o web.
Revisión rápida de endpoints problemáticos donde se sospecha que el backend está enviando tipos de datos incorrectos (ej. un string en lugar de un entero).
Auditoría de APIs heredadas para descubrir campos no documentados que se están filtrando en las respuestas de producción.

Ejemplos

1. Detección de tipos incorrectos y campos faltantes

Desarrollador Backend
Contexto
Un desarrollador está implementando un nuevo endpoint de usuario y quiere asegurarse de que la respuesta coincide con el diseño de la API.
Problema
El frontend reporta errores al procesar el ID del usuario y el estado de actividad porque los tipos de datos no coinciden con lo esperado.
Cómo usarlo
Pega el esquema OpenAPI y el JSON de respuesta real. Configura la ruta en `/users/{id}`, selecciona el método `GET`, ingresa el código `200` y ejecuta la validación.
Resultado
El validador indica que el campo `id` debería ser un entero (no un string), advierte que falta el campo requerido `name`, y señala que `active` tiene un tipo incorrecto.

2. Identificación de campos no documentados

Ingeniero QA
Contexto
El equipo de QA está probando una API de productos antes de su lanzamiento público para asegurar que cumple con los estándares de seguridad y documentación.
Problema
Se necesita garantizar que no se exponga información interna o campos de depuración en la respuesta pública.
Cómo usarlo
Ingresa la especificación del producto, pega el JSON de respuesta real, establece el método en `GET`, el código en `200` y marca la casilla 'Prohibir campos extra'.
Resultado
La herramienta resalta campos internos que están presentes en el JSON de respuesta pero que no existen en el contrato OpenAPI, permitiendo al equipo corregir la fuga de datos.

Probar con muestras

json
Colecciones Postman - Pruebas API
Ejemplos completos de colecciones Postman incluyendo pruebas de API, scripts de automatización, variables de entorno, servidores mock y patrones avanzados de prueba para REST APIs
title token api
json
Ejemplos de AWS EventBridge
Ejemplos de AWS EventBridge incluyendo buses de eventos, reglas, objetivos, registro de esquemas, eventos personalizados y enrutamiento de eventos entre cuentas para arquitectura serverless event-driven
preferred input family json
json
Ejemplos de Apache Pulsar
Ejemplos de Apache Pulsar incluyendo pub/sub, lectores, consumidores con diferentes tipos de suscripción, gestión de esquemas y almacenamiento jerárquico para mensajería empresarial
preferred input family json
json
Ejemplos OpenAPI/Swagger
Ejemplos completos de documentación API usando OpenAPI 3.0 y especificaciones Swagger para servicios RESTful
preferred input family json
json

Hubs relacionados

Herramientas de Json para Validate
Explora 7 herramientas de json para flujos de validate y encuentra utilidades cercanas con rapidez.
Herramientas de Json para Convert
Explora 100 herramientas de json para flujos de convert y encuentra utilidades cercanas con rapidez.
Herramientas de Json
Explora 45 herramientas de json para flujos de utility y encuentra utilidades cercanas con rapidez.
Herramientas de Json para Generate
Explora 33 herramientas de json para flujos de generate y encuentra utilidades cercanas con rapidez.

Preguntas frecuentes

¿Qué versiones de OpenAPI soporta esta herramienta?

Actualmente soporta especificaciones basadas en el estándar OpenAPI 3.x.

¿Qué significa la opción de prohibir campos extra?

Al activarla, la herramienta generará advertencias si el JSON de respuesta contiene propiedades que no están descritas explícitamente en el esquema de la especificación.

¿Es necesario indicar si mi especificación es YAML o JSON?

No, puedes dejar la opción de formato en 'Auto' y el validador detectará automáticamente si el texto introducido es YAML o JSON.

¿Cómo sabe la herramienta qué esquema validar?

Utiliza la combinación de la ruta (path), el método HTTP y el código de estado que ingreses para localizar la respuesta exacta dentro de tu documento OpenAPI.

¿Puedo validar respuestas que no sean JSON?

No, esta herramienta está diseñada exclusivamente para validar cargas útiles (payloads) de respuesta en formato JSON.

Documentación de la API

Punto final de la solicitud

POST /es/api/tools/api-response-contract-validator

Parámetros de la solicitud

Nombre del parámetro Tipo Requerido Descripción
openApiSpec textarea Sí -
responseJson textarea Sí -
path text Sí -
method select No -
statusCode text Sí -
specFormat select No -
disallowAdditionalProperties checkbox No -

Formato de respuesta

{
  "result": "
Processed HTML content
",
  "error": "Error message (optional)",
  "message": "Notification message (optional)",
  "metadata": {
    "key": "value"
  }
}
HTML: HTML

Documentación de MCP

Agregue este herramienta a su configuración de servidor MCP: 

{
  "mcpServers": {
    "elysiatools-api-response-contract-validator": {
      "name": "api-response-contract-validator",
      "description": "Valida un JSON de respuesta real contra el schema de respuesta declarado en OpenAPI 3.x",
      "baseUrl": "https://elysiatools.com/mcp/sse?toolId=api-response-contract-validator",
      "command": "",
      "args": [],
      "env": {},
      "isActive": true,
      "type": "sse"
    }
  }
}

Puede encadenar múltiples herramientas, por ejemplo: `https://elysiatools.com/mcp/sse?toolId=png-to-webp,jpg-to-webp,gif-to-webp`, máximo 20 herramientas.

Si encuentra algún problema, por favor, póngase en contacto con nosotros en [email protected]