ShowDoc

ShowDoc（官网地址showdoc.com.cn）是一个专为IT团队设计的在线API文档和技术文档协作平台。写接口文档不用Word传来传去，打开网页写API说明，参数表格清晰，代码示例一键复制，还能从代码注释、Swagger、Postman自动生成文档。支持数据字典、团队手册、权限管理，开源免费可以自己部署，已经有10万+开发团队在用。

ShowDoc官方网站入口：https://www.showdoc.com.cn/

核心功能

• API文档：快速写接口文档，支持GET/POST等方法，参数表格清晰，代码示例一键复制。
• 自动生成文档：从代码注释、Swagger、Postman自动导入生成文档。
• 数据字典：可视化展示数据库表结构和字段说明。
• 团队手册：写团队规范、技术方案、使用指南。
• Markdown编辑：用Markdown写文档，排版方便。
• RunAPI调试：文档里直接调试接口，Mock数据，前后端联调方便。
• 团队协作：多人一起写文档，不同权限等级管理。
• 版本历史：文档修改有记录，能看历史和回滚。
• AI协作：内置MCP，AI编辑器能直接读写最新文档。
• 全文搜索：文档多了搜关键词秒找。
• 开源免费：可以免费自己部署，数据自己掌握。
• 一键分享导出：文档生成链接分享或导出。

用户群体

ShowDoc面向程序员、后端开发、前端开发、测试、技术团队负责人使用。适合写API接口文档、管理数据库字典、团队技术方案沉淀、前后端联调、开源项目文档等场景。

ShowDoc以API文档快速写、自动生成、开源自部署为核心定位，解决开发团队接口文档用Word写来回传、不同步、找不到最新版的问题，是程序员写技术文档的开源利器。