showdoc生成文档笔记

目录

1.运行环境

2.安装showdoc

3.项目管理

4.生成文档

---

1.运行环境

windows环境 推荐使用phpstudy

官网地址：https://www.xp.cn/

linux环境：可以用lnmp

官网地址：https://lnmp.org/install.html

具体安装流程官网。

2.安装showdoc

1.自动脚本安装：

 #下载脚本并赋予权限
   wget https://www.showdoc.cc/script/showdoc;chmod +x showdoc;
  #默认安装中文版。如果想安装英文版，请加上en参数，如 ./showdoc en
  ./showdoc

 

2.手动安装：

下载项目文件后解压到网站根目录即可，下载地址：https://github.com/star7th/showdoc

备注：php.ini 记得把以下扩展启用：

1.extension=php_sqlite.dll

2.extension=php_pdo_sqlite.dll

3.extension=php_mbstring.dll

直接在php.ini中搜索关键字 把前边的;删除保存 就启用了。

3.运行安装程序

如图就是安装成功了！

 

3.项目管理

1.注册账号

2.新建个项目

3.配置项目

4.获取api_key 和api_token 

到这里项目已经创建完成了。

5.超级管理员

默认登录账号是showdoc 密码是123456

登录后可以进入管理后台对用户和项目进行管理

4.生成文档

1.windows环境需要安装git用来运行脚本  下载地址：https://github.com/git-for-windows/git/releases/download/v2.23.0.windows.1/Git-2.23.0-32-bit.exe

2.配置脚本  脚本下载地址：https://www.showdoc.cc/script/showdoc_api.sh

4.注释模板

/**
	* 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
	*/

5.执行脚本生成文档

1.把脚本放到需要生成文档的项目内 

2.windows环境 需要打开git终端（在项目文件夹空白处右键）

然后执行

./showdoc_api.sh

linux环境下 直接接执行 

./showdoc_api.sh

至此文档已生成 可以登录后台管理和查看文档了