Development

Detector de breaking changes de API e planejador de migracao

Compara dois schemas OpenAPI 3.x, encontra mudancas incompatíveis e sugere estrategias de migracao

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/api-breaking-changes-detector-migration-planner' \
  -H 'Content-Type: application/json' \
  -d '{"oldSchema":"openapi: 3.0.3\npaths:\n  /users:\n    post:\n      requestBody:\n        required: false\n        content:\n          application/json:\n            schema:\n              type: object\n              properties:\n                name: { type: string }\n      responses:\n        \"200\":\n          description: ok\n          content:\n            application/json:\n              schema:\n                type: object\n                properties:\n                  id: { type: string }\n                  name: { type: string }\n","newSchema":"openapi: 3.0.3\npaths:\n  /users:\n    post:\n      requestBody:\n        required: true\n        content:\n          application/json:\n            schema:\n              type: object\n              required: [name, role]\n              properties:\n                name: { type: string }\n                role: { type: string }\n      responses:\n        \"200\":\n          description: ok\n          content:\n            application/json:\n              schema:\n                type: object\n                properties:\n                  id: { type: string }\n"}'

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/api-breaking-changes-detector-migration-planner

Parâmetros

Nome	Tipo	Obrigatório	Descrição
oldSchema	textarea	Não	—
newSchema	textarea	Não	—

Formato de resposta

Resultado HTML

JSON

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

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-api-breaking-changes-detector-migration-planner": {
      "name": "api-breaking-changes-detector-migration-planner",
      "description": "Compara dois schemas OpenAPI 3.x, encontra mudancas incompatíveis e sugere estrategias de migracao",
      "baseUrl": "https://api.elysiatools.com/mcp/sse?toolId=api-breaking-changes-detector-migration-planner",
      "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": "api-breaking-changes-detector-migration-planner",
    "arguments": {
  "oldSchema": "openapi: 3.0.3\npaths:\n  /users:\n    post:\n      requestBody:\n        required: false\n        content:\n          application/json:\n            schema:\n              type: object\n              properties:\n                name: { type: string }\n      responses:\n        \"200\":\n          description: ok\n          content:\n            application/json:\n              schema:\n                type: object\n                properties:\n                  id: { type: string }\n                  name: { type: string }\n",
  "newSchema": "openapi: 3.0.3\npaths:\n  /users:\n    post:\n      requestBody:\n        required: true\n        content:\n          application/json:\n            schema:\n              type: object\n              required: [name, role]\n              properties:\n                name: { type: string }\n                role: { type: string }\n      responses:\n        \"200\":\n          description: ok\n          content:\n            application/json:\n              schema:\n                type: object\n                properties:\n                  id: { type: string }\n"
}
  }
}

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]