1ShowDoc是什么？

ShowDoc是一款开源的在线API文档和技术文档管理工具，支持Markdown编辑、团队协作、接口调试等功能。

开发团队可以在浏览器中编写结构清晰的技术文档并通过生成的数据字典、接口文档与前端、测试等角色高效对齐。

产品以其免费开源和可私有化部署的特点在技术团队中广受欢迎。

该工具由国内开发者star7th创建并开源维护，最早的版本发布于2016年。

与Swagger和YApi等已有的接口管理和Mock平台不同，ShowDoc在”文档的编写和维护体验”上下了更多功夫——它不仅管理API的入参和出参，更兼顾了项目的整体技术文档、数据字典、部署手册等更大范围的文档协作需求。

2核心功能

核心功能包含 4 个板块，按需取用：

3特色亮点

和同类站点相比，它的差异化价值在于：

与Swagger在代码中生成接口文档并由程序自动检测接口状态的技术角色定位和YApi在Mock数据和接口测试上的强大插件生态不同，ShowDoc的优势在于同时服务技术文档和非技术文档的编写——产品的需求文档、接口文档、数据字典可以放在同一个工具中用统一的Markdown格式来维护。

私有化部署的方式让数据完全掌握在企业自己手中。

4用户群体

5实用场景

把 ShowDoc 放进你的日常，可以这样用：

6同类推荐

按需求搭配收藏，获取更立体的信息视角：

常见问题 FAQ