再也不用为写文档发愁了!
你是否也曾为文档烦恼?
作为开发者,我们都知道文档的重要性。但现实往往是:
如果 AI 能帮你搞定这一切,会怎样?
现在,这个愿望实现了!🎉
✨ ShowDoc 正式支持 MCP 协议
MCP(Model Context Protocol) 是一种开放协议,让 AI 助手能够直接与外部工具交互。
简单说就是:你的 AI 编辑器(如 Cursor、Cline、Claude Desktop 等)现在可以直接帮你生成和管理 ShowDoc 文档了!
🔥 推荐工作流:AI 写代码 → AI 写文档 → 前端看文档写请求
现在越来越多的开发者开始用 AI 编辑器写代码。我们推荐这样一个高效的工作流:
┌─────────────────────────────────────────────────────────────┐
│ │
│ 1️⃣ AI 帮你写后端代码 │
│ ↓ │
│ 2️⃣ 顺手让 AI 把接口文档写入 ShowDoc │
│ ↓ │
│ 3️⃣ 前端同学直接看文档,让 AI 根据文档生成网络请求代码 │
│ │
└─────────────────────────────────────────────────────────────┘
一气呵成,全程不用手动写文档!
具体怎么操作?
后端同学在 AI 编辑器中:
"帮我写一个用户登录接口,写完后把接口文档同步到 ShowDoc"
AI 写完代码,自动把文档也写好了!
前端同学在 AI 编辑器中:
"从 ShowDoc 读取登录接口文档,帮我生成网络请求代码"
AI 读取文档,自动生成对应的请求代码!
前后端协作,文档驱动,效率翻倍! 🚀
🎯 更多使用场景
📝 场景一:让 AI 帮你生成文档
"帮我创建一个用户登录接口的文档,包含接口地址、参数说明、返回示例"
AI 自动完成! 不用再纠结格式,不用再手动填写每个字段。
🔄 场景二:自动维护文档
代码变更后,直接告诉 AI:
"根据我最新的代码,更新用户模块的接口文档"
文档与代码永远同步! 再也不会出现"文档是旧的"这种尴尬。
🔍 场景三:智能搜索
"帮我找一下关于支付的文档"
AI 帮你快速定位! 不管有多少项目、多少文档,都能准确找到。
📦 场景四:批量操作
"把这个 OpenAPI 文档导入到 ShowDoc"
一键搞定! 十几个接口文档瞬间创建完成。
⚡ 3 分钟快速配置
第一步:获取 AI 令牌(1 分钟)
-
1. 登录 ShowDoc,进入「用户中心」→「令牌管理」
-
2. 点击「创建令牌」
-
3. 选择权限(建议先选「读写」+「指定项目」)
-
4. 复制生成的令牌(以 ai_ 开头)
第二步:配置 AI 编辑器(2 分钟)
在你的 AI 编辑器中添加 MCP 配置:
{
"mcpServers": {
"showdoc": {
"type": "streamable-http",
"url": "https://www.showdoc.com.cn/mcp.php",
"headers": {
"Authorization": "Bearer 你的AI令牌"
}
}
}
}
配置位置参考:
|
|
|
|
编辑器
|
配置位置
|
|
|
|
|
Cursor
|
设置 → MCP
|
|
VS Code + Cline
|
Cline 扩展设置 → MCP Servers
|
|
Claude Desktop
|
配置文件 claude_desktop_config.json
|
|
|
|
第三步:开始使用
重启编辑器,直接对 AI 说:
"列出我的所有 ShowDoc 项目"
能正常返回就说明配置成功!🎉
🔐 安全可控
我们深知安全的重要性,所以设计了完善的权限控制:
-
• 只读模式:AI 只能看,不能改
-
• 指定项目:限制 AI 只能访问特定项目
-
• 细粒度控制:是否允许创建/删除项目,由你决定
💡 建议:先用「读写」+「指定项目」模式,既方便又安全。
🎁 立即体验
ShowDoc MCP 功能现已上线!
让 AI 帮你生成文档,从此告别手写文档的烦恼!
📬 有问题?
如果觉得这个功能有用,欢迎点赞、在看、转发三连! ⬇️
让更多开发者知道这个提升效率的神器!