ShowDoc

一、网站简介

　　ShowDoc是一款开源的在线API文档和技术文档管理工具，支持Markdown编辑、团队协作、接口调试等功能。开发团队可以在浏览器中编写结构清晰的技术文档并通过生成的数据字典、接口文档与前端、测试等角色高效对齐。产品以其免费开源和可私有化部署的特点在技术团队中广受欢迎。

二、背景介绍

　　该工具由国内开发者star7th创建并开源维护，最早的版本发布于2016年。与Swagger和YApi等已有的接口管理和Mock平台不同，ShowDoc在”文档的编写和维护体验”上下了更多功夫——它不仅管理API的入参和出参，更兼顾了项目的整体技术文档、数据字典、部署手册等更大范围的文档协作需求。产品在GitHub上积累了超过一万个Star，是企业自建知识库的常见选择之一。

三、核心功能

　　接口文档管理可以方便地记录每一个接口的地址、参数、返回值的示例、说明，并自动生成可视化的API文档供团队查阅；数据字典为项目的数据库字段、枚举值、状态码等公共定义提供一个统一的维护和维护入口，各方人员都从同一个数据源获取定义避免了各自维护带来的不一致；团队协作分享以团队为单位管理人权限并支持在线编辑和评论的协作模式。

四、特色亮点

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

五、适用人群

　　后端和前端的工程师在日常的联调和接口对齐中需要一个统一和维护方便的技术文档来源的开发者群体；技术团队负责人需要为团队建立一个统一的知识库和文档规范来保证新人入职后的知识交接效率；开源项目的维护者需要一个轻量且免费的开源文档解决方案来为项目提供对外可见的文档站点。

六、实用场景

　　一个五人创业团队在搭建自己的产品后使用了ShowDoc搭建了内部的接口文档、数据字典、部署手册三位一体的技术Wiki，新成员的入职时间从之前的一周摸索文档变成了两天的结构化学习。团队还在公网上搭建了一个只读版本的项目站点供外部合作方了解API。

七、常见问题（FAQ）

Q：ShowDoc和Swagger在技术团队中怎么分工？
A：Swagger在代码、接口的自动同步、状态检测上更专业，适合以API版本和接口变动频繁的开发型团队；ShowDoc在技术文档的整体覆盖（数据字典、部署手册、需求文档等）和团队协作的可读性上更全面。团队可以在接口这边用Swagger，在高层次的技术知识库上用ShowDoc。

Q：是否可以部署在自己的服务器上？
A：作为完全开源的工具，可以在自己的服务器上部署一套独立的实例，数据、用户、权限完全由团队自己控制。在GitHub上可以找到完整的中文部署教程和配置文档。

Q：是否完全免费？
A：社区版开源且完全免费，且不限制用户数和项目数。官方的在线托管服务（showdoc.com.cn）也提供了一定的免费额度，付费版增加了额外的存储和高级功能。

八、同类推荐

　　Swagger在从代码到API文档的自动同步和接口测试上做了最经典的工具，几乎是后端技术团队的必备；YApi在接口Mock、插件生态、自动化测试上的丰富程度更适合复杂的前后端联调场景；语雀在企业、团队的知识管理、非技术文档的编辑上有更强的综合性。三者与ShowDoc在技术API到代码到企业Wiki的不同文档维度上各具特色。

ShowDoc快速直达链接：https://www.showdoc.com.cn/。H139网址导航提醒您，按Ctrl+D可以快速收藏哦！