Development
从 OpenAPI 或注释生成美观的 API 文档
用三种语言从你的代码中调用此工具。
curl -X POST 'https://api.elysiatools.com/zh/api/tools/api-doc-generator' \
-H 'Content-Type: application/json' \
-d '{"sourceText":"{\n \"openapi\": \"3.0.0\",\n \"info\": {\n \"title\": \"Demo User API\",\n \"version\": \"1.2.0\",\n \"description\": \"User management endpoints\"\n },\n \"servers\": [\n {\n \"url\": \"https://api.example.com\"\n }\n ],\n \"paths\": {\n \"/users/{id}\": {\n \"get\": {\n \"summary\": \"Get user by ID\",\n \"tags\": [\n \"users\"\n ],\n \"parameters\": [\n {\n \"in\": \"path\",\n \"name\": \"id\",\n \"required\": true,\n \"description\": \"User identifier\",\n \"schema\": {\n \"type\": \"string\",\n \"example\": \"u_123\"\n }\n }\n ],\n \"responses\": {\n \"200\": {\n \"description\": \"User payload\",\n \"content\": {\n \"application/json\": {\n \"example\": {\n \"id\": \"u_123\",\n \"name\": \"Ada\"\n }\n }\n }\n },\n \"404\": {\n \"description\": \"User not found\"\n }\n }\n }\n }\n },\n \"components\": {\n \"schemas\": {\n \"User\": {\n \"type\": \"object\",\n \"required\": [\n \"id\",\n \"name\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}","sourceFormat":"json","outputFormat":"markdown","documentTitle":"Demo User API","theme":"slate","includeExamples":true,"includeSchemas":true}'以 JSON 形式 POST 提交输入参数。文件类型参数需先单独上传。
POST https://api.elysiatools.com/zh/api/tools/api-doc-generator| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| sourceText | textarea | 是 | — |
| sourceFormat | select | 否 | — |
| outputFormat | select | 否 | — |
| documentTitle | text | 否 | — |
| theme | select | 否 | — |
| includeExamples | checkbox | 否 | — |
| includeSchemas | checkbox | 否 | — |
文件结果
{
"filePath": "/public/processing/randomid.ext",
"fileName": "output.ext",
"contentType": "application/octet-stream",
"size": 1024,
"metadata": {
"key": "value"
},
"error": "Error message (optional)",
"message": "Notification message (optional)"
}将此工具加入你的 Model Context Protocol 服务,让 AI 智能体可以列出并调用它。
将以下内容加入你的 MCP 客户端配置:
{
"mcpServers": {
"elysiatools-api-doc-generator": {
"name": "api-doc-generator",
"description": "从 OpenAPI 或注释生成美观的 API 文档",
"baseUrl": "https://api.elysiatools.com/mcp/sse?toolId=api-doc-generator",
"command": "",
"args": [],
"env": {},
"isActive": true,
"type": "sse"
}
}
}连接到 SSE 端点后,列出已开放的工具:
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/list"
}通过工具 id 调用,参数由其参数表构建:
{
"jsonrpc": "2.0",
"id": 2,
"method": "tools/call",
"params": {
"name": "api-doc-generator",
"arguments": {
"sourceText": "{\n \"openapi\": \"3.0.0\",\n \"info\": {\n \"title\": \"Demo User API\",\n \"version\": \"1.2.0\",\n \"description\": \"User management endpoints\"\n },\n \"servers\": [\n {\n \"url\": \"https://api.example.com\"\n }\n ],\n \"paths\": {\n \"/users/{id}\": {\n \"get\": {\n \"summary\": \"Get user by ID\",\n \"tags\": [\n \"users\"\n ],\n \"parameters\": [\n {\n \"in\": \"path\",\n \"name\": \"id\",\n \"required\": true,\n \"description\": \"User identifier\",\n \"schema\": {\n \"type\": \"string\",\n \"example\": \"u_123\"\n }\n }\n ],\n \"responses\": {\n \"200\": {\n \"description\": \"User payload\",\n \"content\": {\n \"application/json\": {\n \"example\": {\n \"id\": \"u_123\",\n \"name\": \"Ada\"\n }\n }\n }\n },\n \"404\": {\n \"description\": \"User not found\"\n }\n }\n }\n }\n },\n \"components\": {\n \"schemas\": {\n \"User\": {\n \"type\": \"object\",\n \"required\": [\n \"id\",\n \"name\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}",
"sourceFormat": "json",
"outputFormat": "markdown",
"documentTitle": "Demo User API",
"theme": "slate",
"includeExamples": true,
"includeSchemas": true
}
}
}有问题或反馈?请联系 [email protected]