showdoc使用

Posted 2023-04-09

参考技术A 官方地址 https://www.showdoc.com.cn/
登录并创建一个项目,如图：

再项目设置中有开发api,点开如下：

上述的环境和脚本下好了后，将脚本放在需要生成接口文档的目录下，并编辑：
api_key、api_token、url三个属性，api_key和api_token都在上面的项目设置中复制粘贴即可，url默认是 url=https://www.showdoc.com.cn/server/?s=/api/open/fromComments ，但如果是使用开源版showdoc，则需要将地址改为 http://xx.com/server/index.php?s=/api/open/fromComments ，否则就不需要修改。

首先再接口头部写上注释，参考：
/**
* showdoc
* @catalog 测试文档/用户相关
* @title 用户登录
* @description 用户登录的接口
* @method get
* @url https://www.showdoc.cc/home/user/login
* @header token 可选 string 设备token
* @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
*/
然后运行shoudoc脚本（windows要配合git使用），然后就可以再自己showdoc工作台的项目中看见接口了，示例：

使用git:
右键showdoc_api.sh，选择打开方式，在其他打开方式中选择git安装目录下的bin>sh.exe；
或右键showdoc_api.sh：

Docker搭建Showdoc

 

基础安装

安装前请确保你的环境已经装好了docker 

 

docker pull star7th/showdoc

 

#新建存放showdoc数据的目录

mkdir /opt/showdoc

mkdir /showdoc/html

chmod -R 777 /showdoc

 

#启动showdoc容器

docker run -d --name showdoc -p 4999:80 -v /showdoc/html:/var/www/html/ star7th/showdoc

根据以上命令操作的话，往后showdoc的数据都会存放在 /showdoc/html 目录下。
你可以打开 http://localhost:4999 来访问showdoc (localhost可改为你的服务器域名或者IP)。账户密码是showdoc/123456，登录后你便可以看到右上方的管理后台入口。建议登录后修改密码。

 

如何升级

这里的升级是针对上面docker安装方式的升级。如果你原来是采用非docker安装方式（如php安装方式）的话，请跳过本部分文字，直接去看下部分。

1. //停止容器
2. docker stop showdoc
4. //下载最新代码包
5. wget https://github.com/star7th/showdoc/archive/master.tar.gz
6. //解压
7. tar -zxvf master.tar.gz -C /showdoc_data/
9. rm -rf /showdoc_data/html_bak
10. //备份。如果可以的话，命令中的html_bak还可以加上日期后缀，以便保留不同日期的多个备份
11. mv /showdoc/html /showdoc/html_bak
12. mv /showdoc_data/showdoc-master /showdoc_data/html ##// */
14. //赋予权限
15. chmod -R 777 /showdoc_data/html
17. //启动容器
18. docker start showdoc
20. //执行安装。默认安装中文版。如果想安装英文版，将下面参数中的zh改为en
21. curl http://localhost:4999/install/non_interactive.php?lang=zh
23. //转移旧数据库
24. cp -f /showdoc_data/html_bak/Sqlite/showdoc.db.php /showdoc_data/html/Sqlite/showdoc.db.php
26. //转移旧附件数据
27. cp -r -f /showdoc_data/html_bak/Public/Uploads /showdoc_data/html/Public/Uploads
29. // 执行数据库升级，看到OK字样便证明成功
30. curl http://localhost:4999?s=/home/update/db
32. //如果中途出错，请重命名原来的/showdoc_data/html_bak文件为/showdoc_data/html ，然后重启容器便可恢复。

 

数据备份

备份/showdoc_data/html 目录即可。比如执行下面命令压缩存放

1. zip -r /showdoc_data/showdoc_bak.zip /showdoc_data/html
2. //其中showdoc_bak.zip可以用日期后缀命名，以便多个备份。你也可以用定时任务来实现定时备份。

其他参考命令

1. docker stop showdoc //停止容器
2. docker restart showdoc //重启showdoc容器
3. docker rm showdoc //删除showdoc容器
4. docker rmi star7th/showdoc //删除showdoc镜像
5. docker stop $(docker ps -a -q) ;docker rm $(docker ps -a -q) ;//停止并删除所有容器。危险命令，不懂勿用。

 

已上内容来自showdoc官方：https://www.showdoc.cc/help?page_id=65610

安装目录根据个人情况调整。