Openapi Inspector

none.api - OpenAPI Explorer MCP 服务

面向模型上下文协议（MCP）的专业 OpenAPI 探索器，针对前端开发和后端契约验证进行了优化。

这是什么？

此 MCP 服务允许 Claude 或 Cursor 等大语言模型（LLM）动态探索、理解并与任何具有 OpenAPI/Swagger 规范的 API 交互。

它专为以下用途设计：

1. 加速前端开发：直接根据 API 定义生成类型、Zod 模式、模拟数据和数据获取钩子（Axios/TanStack Query）。
2. 验证后端实现：根据 OpenAPI 契约验证后端响应对象，确保实现与规范一致。

安装

使用 npx（推荐）

无需安装即可直接运行此服务：

npx @nonetss/none.api

全局安装

npm install -g @nonetss/none.api

主要功能

• 智能探索：按类别列出端点，并支持基于关键词的搜索（支持多语言同义词）。
• 前端工厂：
  • 生成请求和响应的 TypeScript 接口。
  • 生成用于表单验证的 Zod 模式。
  • 生成 React/Axios/TanStack Query 代码片段。
  • 生成用于 UI 原型设计的 模拟数据。
• 后端守护：
  • 响应验证：使用 AJV 对照 OpenAPI 模式验证 JSON 数据。
  • 依赖关系映射：了解资源之间的关系（例如，哪个端点会提供另一个端点所需的 ID）。
• 安全性：自动支持身份验证（Bearer/API Key），并采用安全的环境锁定配置。

工具概览

工具	重点	描述
list_endpoints	探索	列出按功能类别分组的所有端点。
list_tags	探索	列出 API 中的所有标签（功能类别）。
search_by_tag	探索	列出与特定标签关联的所有端点。
find_endpoint	探索	根据意图或关键词进行智能搜索（例如，“删除用户”）。
get_endpoint_info	分析	提供详细文档、参数和响应代码。
get_request_schema	分析	返回端点请求正文的 JSON 模式。
get_response_schema	分析	返回特定响应状态代码的 JSON 模式。
get_typescript_types	前端	生成可直接使用的 TypeScript 接口。
get_zod_schema	前端	生成 Zod 验证模式。
get_framework_snippet	前端	生成 Axios 或 TanStack Query 代码。
get_fetch_snippet	前端	生成原生 fetch 代码片段，便于快速集成。
get_mock_data	原型设计	根据模式生成高保真模拟数据。
map_dependencies	架构	分析路由之间的数据流和 ID 关系。
get_security_info	安全	显示 API 或特定路由的安全要求。
set_security_context	安全	设置后续请求使用的身份验证标头。
call_endpoint	调试	向已配置的 API 发起真实 HTTP 调用。
validate_response	后端	根据 API 契约验证 JSON 对象。

配置

将以下内容添加到你的 claude_desktop_config.json 或 Cursor MCP 设置中：

{
  "mcpServers": {
    "none.api": {
      "command": "npx",
      "args": ["-y", "@nonetss/none.api"],
      "env": {
        "OPENAPI_URL": "http://localhost:3000/doc",
        "AUTH_EMAIL": "[email protected]",
        "AUTH_PASSWORD": "your-password",
        "AUTH_PATH": "/api/auth/login"
      }
    }
  }
}

开发工作流

1. 构建：npm run build（使用 tsc + tsc-alias 解析路径）。
2. 格式化：已集成 Prettier。
3. Git 钩子：通过 husky 和 lint-staged 在提交时自动格式化。