ShowDoc

ShowDoc详细介绍

ShowDoc的定位很明确，就是给IT团队写文档用的，尤其擅长API接口文档、数据字典、技术规范这几类研发场景里最高频又最没人愿意维护的内容。它以项目、目录、页面三级结构组织文档，原生用Markdown编辑，编辑器顶部一键插入API接口模板和数据字典模板，填字段就行，不用从零排版。对前后端联调来说，接口地址、入参、出参、错误码、示例都摆在一张表里，比口头沟通或Word传来传去省事太多。

实际把它接到工作流里，最让人省心的是自动化那一环。后端写完接口，在代码注释里按showdoc规范标注一下@url、@param、@return，跑一遍官方脚本showdoc_api.sh，接口文档就自动同步进项目了，不用再手动抄一遍。配RunApi客户端调试接口，点一下同步到ShowDoc，文档跟着调试结果走，参数变了文档也跟着变。这套流程跑顺之后，文档滞后于代码的老问题基本就解决了，维护成本降得很明显。当然前提是团队愿意统一遵守注释规范，否则自动化也救不回来。

它不是万能的。知识管理能力比语雀、Notion那种通用知识库弱一截，全文搜索、内容关联、富文本混排都不是强项，更适合结构化的技术文档而不是发散式笔记。免费版限5个协作成员、10个项目、100M附件空间，小团队够用，稍大一点的研发团队基本得升到高级版或专业版。好在它开源，Apache2协议，想完全掌控数据就Docker拉起来私有部署，默认账号showdoc/123456记得第一时间改掉。综合看，纯做API文档和数据字典的中小研发团队，ShowDoc是性价比很高的选择；想要更强的通用知识库和协作体验，语雀、飞书知识库、Notion这类更合适。

ShowDoc的核心功能

• API文档：编辑页一键插入API接口模板，按HTTP方法、URL、请求头、入参、返回示例、错误码填表，支持GET/POST/PUT/DELETE标识，生成的接口表清晰可一键复制curl示例，前后端联调直接对着看。
• 数据字典：内置数据字典模板，逐表逐字段录入字段名、类型、说明、索引，自动渲染成可视化表结构，支持MySQL等多种数据库格式，可一键导出SQL，DBA和开发对库结构有统一参照。
• 代码注释自动生成文档：在代码里按showdoc注释规范标注@catalog、@title、@url、@param、@return等，运行官方脚本showdoc_api.sh递归扫描目录，自动把接口写进指定项目，参数变了重跑一遍就同步。
• RunApi接口调试：搭配的RunApi客户端类似Postman，发请求调试接口后点同步到ShowDoc，文档跟着调试结果走，调试即写文档，省去重复录入。
• 团队协作与权限：项目分公开和私密两类，私密项目需密码访问；可添加项目成员、团队成员并分配编辑或查看权限，支持项目转让，主账户买套餐后协作成员不用再付费。
• 历史版本与导出：每个页面保留历史版本可随时回滚，免费版5个、旗舰版不限；项目可导出为Word文件离线浏览或外发，响应式网页也能分享到手机查看。
• 多平台与私有部署：提供网页版、Windows、Mac、iOS、Android客户端；开源版基于Apache2协议，Docker一行命令拉起私有部署，数据存自己服务器，手机App登录时可指定私有服务器地址。
• MCP接入AI编辑器：提供MCP（Model Context Protocol）接入能力，可在Cursor、Claude等AI编辑器里直接调用ShowDoc，让AI写完代码顺手把接口文档写入项目，前端再根据文档生成请求代码，实现文档与代码同步而无需手写。

ShowDoc的价格详情

免费权益：

免费版0元/年，可用大部分功能：5个协作成员、10个项目、附件/图片空间100M、图片访问流量500M/月、每项目100个页面、5个页面历史版本、每三天可导出项目一次；开源版基于Apache2协议完全免费，开源仓库当前发布至v3.9.2，可Docker自行部署。价格可能随官方调整。

收费模式：

ShowDoc的应用场景

• API文档中心：把全公司所有系统的接口地址、入参、出参、错误码、示例集中到一个项目里，按模块分目录，前端、后端、外部对接方对着同一份文档联调，不再靠口头或微信传接口说明。
• 数据字典维护：DBA和开发把每张表的字段、类型、含义、索引录入数据字典模板，配合showdoc_db.sh脚本定时从MySQL同步表结构，字段含义变了文档自动更新，省去手动维护desc命令查库的麻烦。
• 代码注释自动出文档：后端在接口代码里按showdoc注释规范标注，CI流程里跑showdoc_api.sh，提交代码即同步接口文档，文档和代码不再脱节。
• 接口调试即写文档：用RunApi客户端发请求调试接口，调通后点同步到ShowDoc，文档跟着真实请求参数走，调试和文档维护合二为一。
• 团队技术知识库：把系统架构图、模块划分、部署手册、运维排障步骤、常见FAQ沉淀到项目里，新成员入职对着看，减少重复口述交接。
• 对外文档发布：把需要给客户或合作方看的接口说明、产品手册设为公开项目，对方不登录直接访问；敏感内部文档设为私密项目加密码访问，一份平台同时对外发布和对内协作。
• AI编辑器联动写文档：通过MCP接入Cursor、Claude等AI编辑器，让AI写完后端代码顺手把接口文档写入ShowDoc，前端再根据文档生成请求代码，文档全程不用手写。

ShowDoc的适用人群

• 后端开发：写完接口直接用代码注释或RunApi把接口文档同步进ShowDoc，不用再单独手写文档，接口参数变了重跑脚本就同步。
• 前端开发：联调时对着ShowDoc里的接口表看地址、入参、返回示例，一键复制curl，不用反复问后端要接口说明。
• 产品经理：在ShowDoc里维护PRD、技术规范、功能说明，review接口文档时对着结构化表格看，比Word散落各处清晰。
• DBA与运维：用数据字典模板管理库结构，定时同步表结构；把部署手册、排障步骤、紧急联系人沉淀成运维知识库，故障时快速定位。
• 技术团队负责人：给团队搭统一的文档中心，公开项目对外发布、私密项目对内协作，权限分级管理，新成员入职有完整文档可查。

同类工具对比

ShowDoc的同类竞品

PostmanPostman是目前全球使用最广泛的AP…ApifoxApifox 是北京睿易辰科技有限公司推…语雀语雀是蚂蚁集团旗下的在线知识库与文档协作…ApipostApipost是由北京北极狐信息科技有限…NotionNotion 把自己定位成一体化工作空间…ConfluenceConfluence 是 Atlassi…