apifox进口mcp
用于将OpenAPI文档导入Apifox的模型上下文协议（MCP）服务器。
特性
- 将OpenAPI导入Apifox：直接将OpenAPI YAML/JSON文件导入Apifox项目
- 验证OpenAPI文件：验证并从OpenAPI文档中提取统计信息
- 易于配置：通过中的环境变量进行配置
.mcp.json - 异步操作：内置async/await以获得最佳性能
- 错误处理：用于故障排除的全面错误消息
安装
使用uvx（推荐）
uvx apifox-import-mcp使用pip
pip install apifox-import-mcp来源
git clone https://github.com/hexonal/apifox-import-mcp.git
cd apifox-import-mcp
pip install -e .配置
添加到您的 .mcp.json:
{
"mcpServers": {
"apifox-import": {
"command": "uvx",
"args": ["apifox-import-mcp"],
"env": {
"APIFOX_PROJECT_ID": "your-project-id",
"APIFOX_ACCESS_TOKEN": "your-access-token"
}
}
}
}环境变量
| 变量 | 必填 | 描述 | 默认值 |
|---|---|---|---|
APIFOX_PROJECT_ID | 是 | Apifox项目ID | - |
APIFOX_ACCESS_TOKEN | 是 | Apifox访问令牌 | - |
APIFOX_API_BASE | 否 | API基础URL | https://api.apifox.com/api/v1 |
工具
进口
将OpenAPI文档导入Apifox项目。
参数：
file_path（必填）：OpenAPI YAML/JSON文件的绝对路径delete_unmatched（可选）：是否删除不匹配的资源（默认：true)api_overwrite_mode（可选）：API覆盖模式（默认："methodAndPath")
- 选项： "methodAndPath", "ignore", "all"
schema_overwrite_mode（可选）：架构覆盖模式（默认："title")
- 选项： "title", "ignore", "all"
退货：
{
"status": "success",
"data": {
"api": {
"created": 5,
"updated": 2,
"errors": 0,
"ignored": 0
},
"folder": {
"created": 3,
"updated": 1
}
}
}示例用法：
User: Import the OpenAPI file at /path/to/openapi.yaml to Apifox
Claude: Calling import_openapi tool...validate_openapi
验证OpenAPI文件并提取统计信息。
参数：
file_path（必填）：OpenAPI YAML/JSON文件的绝对路径
退货：
{
"status": "success",
"data": {
"file": "/path/to/openapi.yaml",
"size": "25.3 KB",
"format": "YAML",
"version": "3.0.3",
"endpoints": 5,
"schemas": 12,
"tags": ["Tag1", "Tag2"]
}
}示例用法：
User: Validate the OpenAPI file at /path/to/openapi.yaml
Claude: Calling validate_openapi tool...故障排除
错误：“未设置APIFOX_PROJECT_ID”
确保你的 .mcp.json 包括 APIFOX_PROJECT_ID 环境变量。
错误：“找不到文件：/path/to/File.yaml”
验证文件路径是否正确以及文件是否存在。使用绝对路径，而不是相对路径。
错误：“OpenAPI格式无效”
确保您的文件是有效的YAML或JSON，并符合OpenAPI规范。
错误：“HTTP 401：访问令牌无效”
检查你的 APIFOX_ACCESS_TOKEN 正确且未过期。
错误：“HTTP 404:找不到项目”
验证您的 APIFOX_PROJECT_ID 是正确的。
发展
设置
git clone https://github.com/hexonal/apifox-import-mcp.git
cd apifox-import-mcp
pip install -e ".[dev]"运行测试
pytest tests/ -v代码格式化
black .
isort .类型检查
mypy apifox_import_mcp/许可证
MIT许可证-请参阅 许可证 了解详情。
贡献
欢迎投稿！请在GitHub上打开问题或拉取请求。