ShowDoc 是面向 IT 团队的在线文档协作平台，主要用于编写和管理 API 文档、技术文档、数据字典、工具说明书、技术规范以及团队知识库。它把 API 接口说明、数据库结构和团队文档集中到在线环境中，支持实时访问、权限管理、历史版本追溯和全文搜索，减少通过即时通信工具或邮件分散传递文档的问题。除在线托管外，ShowDoc 还提供免费开源版本，用户可以将其部署到自己的服务器；在 API 开发场景中，还可以搭配 RunAPI 进行接口调试、接口信息同步和文档生成。
核心功能
API 文档编写与展示
ShowDoc 用于整理 APP、Web 前端与服务器之间交互所需的 API 文档，可以快速编写结构清晰的接口说明。文档支持 GET、POST、PUT、DELETE 等 HTTP 方法标识，参数可以通过表格展示，代码示例支持一键复制，并支持 Markdown 格式化。接口文档还可以展示请求参数、响应示例和接口状态信息，便于前后端围绕同一份接口说明进行协作。
数据字典与数据库结构说明
数据字典功能用于描述数据库结构，支持对表结构进行可视化展示，并清晰呈现字段类型和字段说明。正文列出了对 MySQL 表结构的展示示例，同时说明支持多数据库格式。整理完成的数据字典可以一键导出和共享，适合将数据库表、字段以及相关说明集中提供给需要查阅的人员。
技术说明文档与团队协作
ShowDoc 不仅用于 API 和数据库文档，也可以编写工具说明书、技术规范说明文档和团队知识库内容。团队权限管理机制支持多人协同编写文档，并提供多种权限级别控制。评论反馈机制可用于团队成员之间的文档沟通，变更历史追溯则可以查看文档修改记录；平台还支持自动保存历史版本，并可进行追溯和回滚。
多来源文档自动生成与导入
ShowDoc 支持从代码注释自动生成文档，也支持 Swagger/OpenAPI 导入、Postman 一键导入和 Markdown 压缩包导入。这样可以将已有的接口描述或项目文档内容导入到 ShowDoc 中，不必完全依靠手工重新编写。官网还展示了从代码注释生成 API 文档的使用方式，并将 Swagger、Postman 和 Markdown 列为支持的文档来源。
RunAPI 接口调试与文档联动
ShowDoc 可以与 RunAPI 集成，用于接口调试和文档编写的衔接。在 RunAPI 中调试接口时，可以实时同步接口信息到文档，并自动生成文档。两者还支持 Mock 服务与文档联动，接口请求、请求体、响应结果和文档示例可以围绕同一套接口信息协同使用，从而服务于前后端接口开发协作。
使用方式
ShowDoc 提供在线文档托管服务，用户可以在云端托管文档数据；同时，免费开源版本支持部署到自己的服务器。文档内容可通过在线编辑、Markdown、代码注释、Swagger/OpenAPI、Postman 或 Markdown 压缩包等方式建立和导入。API 开发者还可以搭配 RunAPI 调试接口并同步生成文档。正文没有说明需要自备模型 Key，也没有提到客户端、浏览器插件或命令行使用方式。
适用人群与场景
API 开发团队可以用它编写 APP、Web 前端与服务器交互所需的接口文档，展示请求参数、响应示例和代码示例。数据库相关人员可以用数据字典功能整理表结构、字段类型和字段说明，并将结果导出共享。需要维护工具说明书、技术规范或团队知识库的 IT 团队，可以利用在线文档、权限级别、评论反馈和历史版本功能进行协作。使用 Swagger、Postman 或代码注释维护接口的开发者，则可以通过导入和自动生成方式建立 API 文档。
定价
官网明确提供免费开源版本，用户可以选择将 ShowDoc 部署到自己的服务器。正文同时提供在线文档托管服务，但没有列出在线托管的具体价格、套餐或免费额度信息。
