一个非常适合 IT 团队的在线 API 文档、技术文档工具
可以方便地使用 markdown 语法来书写出美观的 API 文档、数据字典文档、技术文档、在线 excel 文档等等。如果不想编辑 markdown 文档，你还可以利用 ShowDoc 的自动化能力，从程序注释中自动生成 API 文档，或者从搭配的 RunApi 客户端中一边调试接口、一边自动生成文档。
1. 工具介绍
主要介绍 ShowDoc 工具的主要特点和优势之处
通过分配项目成员和团队成员，你可以很方便地进行项目文档的权限管理和团队协作，也可以分享文档出去给朋友查看。
- [1] API 文档
- APP、Web 前端与服务器常用 API 来进行交互
- 用 ShowDoc 可以方便快速编写出美观的 API 文档
- [2] 数据字典
- 好的数据字典可以很方便地向别人描述你的数据库结构
- 用 ShowDoc 可以编辑出美观的数据字典
- [3] 说明文档
- 你完全可以使用 ShowDoc 来编写一些工具的说明书
- 也可以编写一些技术规范说明文档以供团队查阅
- [4] 团队协作
- 团队权限管理机制让团队良好地协同编写文档
- [5] 文档自动化
- 可从代码注释中自动生成文档
- 搭配的 RunApi 客户端，可调试接口和自动生成文档
- [6] 免费开源
- ShowDoc 提供免费开源的版本
- 你可以选择将 ShowDoc 部署到你的服务器
ShowDoc 还支持多平台客户端，更方便跨平台使用：
- win 客户端
- mac 客户端
- ios 客户端
- android 客户端
2. 部署方式
如何使用 Docker 私有化部署 ShowDoc 服务
- [1] 基础安装
- 访问地址: http://localhost:8000
- 登陆信息: showdoc/123456
version: "3"
services:
showdoc:
restart: on-failure
container_name: showdoc_web
image: star7th/showdoc
ports:
- "8000:80"
volumes:
- "/showdoc_data/html:/var/www/html"
networks:
- showdoc_network
- postgres
networks:
showdoc_network:
- [2] 绑定域名
- 绑定域名: httptest.showdoc.com.cn
server {
listen 80;
server_name test.showdoc.com.cn;
client_max_body_size 1000m;
location ^~ / {
proxy_pass http://127.0.0.1:8000;
proxy_redirect off;
proxy_connect_timeout 90;
proxy_send_timeout 90;
proxy_read_timeout 90;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header http_user_agent $http_user_agent;
}
}
3. 参考链接
送人玫瑰，手有余香
