showdoc [7.8k]技术文档、API 文档

[TOC] > [demo](https://www.showdoc.cc/demo?page_id=7) ## 概述 1. 可以导出 word 2. 页面可保存为模版 3. 有api 模版与字典模版 4. 有团队管理 5. ldap接入数据 6. 多项目管理 7. makedown形式的编写 8. [自动生成API文档 ](https://www.showdoc.cc/page/741656402509783) 9. 可以脚本或者docker 安装 10. 在代码生成文档 ``` docker pull star7th/showdoc docker run -d --name showdoc -p 4999:80 -v /showdoc_data/html:/var/www/html/ star7th/showdoc ``` ## 特点 ### 可访问局域网接口自动生成文档 需要现在入口文件配置 如 php ``` header("Access-Control-Allow-Origin: *"); header("Access-Control-Allow-Credentials : true"); header("Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Connection, User-Agent, Cookie"); ```   ## 通过代码实现生成接口生成文档 > [参考文档](https://www.showdoc.cc/page/102098) 1. 下载[showdoc_api.sh](https://www.showdoc.cc/script/showdoc_api.sh) 并配置 文件内容,api_key与api_token ``` api_key="ca28bcee7ceb2a7e16089b6b10d2290f986959735" #api_key api_token="d40ab971a70cbab6c6001863f04e50421453112241" #api_token url="http://192.168.0.188:4999/server/?s=/api/open/fromComments" #同步到的url。使用www.showdoc.cc的不需要修改，使用开源版的请修改 ``` 2. window 下需要 git-bash 3. 下载[测试文件](https://www.showdoc.cc/script/api_demo.test) 测试文件说明 ``` /** * showdoc * @catalog 测试文档/用户相关 * @title 用户注册 * @description 用户注册的接口 * @method post * @url https://www.showdoc.cc/home/user/login * @param username 必选 string 用户名 * @param password 必选 string 密码 * @param name 可选 string 用户昵称 * @return {"error_code":0,"data":{"uid":"1","username":"12154545","name":"吴系挂","groupid":2,"reg_time":"1436864169","last_login_time":"0"}} * @return_param groupid int 用户组id * @return_param name string 用户昵称 * @remark 这里是备注信息 * @number 99 */ public function register(){ //code } ``` ``` @catalog 测试文档/用户相关 目录路径,不存在则会创建目录 @title 用户注册 接口名 @number 99 排序 ``` 运行 ``` ./showdoc_api.sh ./showdoc_api.sh /myapp/demo/ ```