Development

Detector de quebra em diff OpenAPI

Compara schemas OpenAPI ou GraphQL, marca breaking changes e gera um relatorio de impacto para equipes de API

Início rápido

Chame esta ferramenta a partir do seu código em três idiomas.

cURL

curl -X POST 'https://api.elysiatools.com/pt/api/tools/openapi-diff-breach-detector' \
  -H 'Content-Type: application/json' \
  -d '{"oldSchema":"openapi: 3.0.0\npaths:\n  /users/{id}:\n    get:\n      responses:\n        \"200\":\n          description: ok\n          content:\n            application/json:\n              schema:\n                type: object\n                properties:\n                  id: { type: string }\n                  email: { type: string }\n","newSchema":"openapi: 3.0.0\npaths:\n  /users/{id}:\n    get:\n      responses:\n        \"200\":\n          description: ok\n          content:\n            application/json:\n              schema:\n                type: object\n                properties:\n                  id: { type: string }\n","schemaType":"openapi","inputFormat":"auto","includeImpactAnalysis":true}'

Referência da API

Envie uma requisição POST com suas entradas em JSON. Parâmetros do tipo arquivo exigem upload prévio.

Endpoint

HTTP

POST https://api.elysiatools.com/pt/api/tools/openapi-diff-breach-detector

Parâmetros

Nome	Tipo	Obrigatório	Descrição
oldSchema	textarea	Sim	—
newSchema	textarea	Sim	—
schemaType	select	Não	—
inputFormat	text	Não	—
includeImpactAnalysis	checkbox	Não	—

Formato de resposta

Resultado JSON

JSON

{
  "key": {...},
  "metadata": {
    "key": "value"
  },
  "error": "Error message (optional)",
  "message": "Notification message (optional)"
}

Integração MCP

Adicione esta ferramenta ao seu servidor Model Context Protocol para que agentes de IA possam listá-la e chamá-la.

Configuração do servidor

Adicione este bloco à configuração do seu cliente MCP:

mcp.json

{
  "mcpServers": {
    "elysiatools-openapi-diff-breach-detector": {
      "name": "openapi-diff-breach-detector",
      "description": "Compara schemas OpenAPI ou GraphQL, marca breaking changes e gera um relatorio de impacto para equipes de API",
      "baseUrl": "https://api.elysiatools.com/mcp/sse?toolId=openapi-diff-breach-detector",
      "command": "",
      "args": [],
      "env": {},
      "isActive": true,
      "type": "sse"
    }
  }
}

Listar ferramentas disponíveis

Após conectar ao endpoint SSE, liste as ferramentas expostas:

tools/list

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/list"
}

Chamar esta ferramenta

Invoque a ferramenta pelo seu id; os argumentos são construídos a partir de seus parâmetros:

tools/call

{
  "jsonrpc": "2.0",
  "id": 2,
  "method": "tools/call",
  "params": {
    "name": "openapi-diff-breach-detector",
    "arguments": {
  "oldSchema": "openapi: 3.0.0\npaths:\n  /users/{id}:\n    get:\n      responses:\n        \"200\":\n          description: ok\n          content:\n            application/json:\n              schema:\n                type: object\n                properties:\n                  id: { type: string }\n                  email: { type: string }\n",
  "newSchema": "openapi: 3.0.0\npaths:\n  /users/{id}:\n    get:\n      responses:\n        \"200\":\n          description: ok\n          content:\n            application/json:\n              schema:\n                type: object\n                properties:\n                  id: { type: string }\n",
  "schemaType": "openapi",
  "inputFormat": "auto",
  "includeImpactAnalysis": true
}
  }
}

Encadeie várias ferramentas em uma sessão com uma lista toolId separada por vírgulas, p. ex. /mcp/sse?toolId=png-to-webp,jpg-to-webp,gif-to-webp (máx. 20).

Dúvidas ou problemas? Contate [email protected]