Development

API 响应契约校验器

将真实 API 响应 JSON 与 OpenAPI 3.x 中声明的 response schema 对照校验

html· HTML 结果打开工具

快速开始

用三种语言从你的代码中调用此工具。

cURL

curl -X POST 'https://api.elysiatools.com/zh/api/tools/api-response-contract-validator' \
  -H 'Content-Type: application/json' \
  -d '{"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}'

API 参考

以 JSON 形式 POST 提交输入参数。文件类型参数需先单独上传。

请求端点

HTTP

POST https://api.elysiatools.com/zh/api/tools/api-response-contract-validator

请求参数

参数名	类型	必填	说明
openApiSpec	textarea	是	—
responseJson	textarea	是	—
path	text	是	—
method	select	否	—
statusCode	text	是	—
specFormat	select	否	—
disallowAdditionalProperties	checkbox	否	—

响应格式

HTML 结果

JSON

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

MCP 集成

将此工具加入你的 Model Context Protocol 服务，让 AI 智能体可以列出并调用它。

服务配置

将以下内容加入你的 MCP 客户端配置：

mcp.json

{
  "mcpServers": {
    "elysiatools-api-response-contract-validator": {
      "name": "api-response-contract-validator",
      "description": "将真实 API 响应 JSON 与 OpenAPI 3.x 中声明的 response schema 对照校验",
      "baseUrl": "https://api.elysiatools.com/mcp/sse?toolId=api-response-contract-validator",
      "command": "",
      "args": [],
      "env": {},
      "isActive": true,
      "type": "sse"
    }
  }
}

列出可用工具

连接到 SSE 端点后，列出已开放的工具：

tools/list

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

调用此工具

通过工具 id 调用，参数由其参数表构建：

tools/call

{
  "jsonrpc": "2.0",
  "id": 2,
  "method": "tools/call",
  "params": {
    "name": "api-response-contract-validator",
    "arguments": {
  "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
}
  }
}

可用逗号分隔的 toolId 在一个会话中串联多个工具，例如 /mcp/sse?toolId=png-to-webp,jpg-to-webp,gif-to-webp（最多 20 个）。

有问题或反馈？请联系 [email protected]