利⽤ShowDoc⾃动⽣成api接⼝⽂档
最近在做新项⽬，感觉写完⼀个接⼝还要去再写⼀遍api⽂档挺浪费时间的，所以借⽤ShowDoc的api开放功能⾃动⽣成api⽂档。⾸先去注册⼀个账户，新建⼀个项⽬，
建⽴新项⽬后，选择该项⽬，打开，进⼊项⽬界⾯
然后点击项⽬，下拉选择项⽬设置，
可以看到开放API，下⾯还有Api⽂档，数据字典⽂档
Windows系统安装步骤：
⾃动化⽣成API⽂档，⾸先需要下载Git ，推荐下载地址：
基础环境。安装好了后，还需要下载showdoc官⽅脚本：
下载后，将showdoc_api.sh放在你的项⽬⽬录下。右击，选择编辑。
脚本内容的前⾯有两个变量，api_key 和 api_token ，这个需要⽤户⾃⾏填写。关于这两个变量的取值，请登录showdoc，进⼊某个项⽬的设置，点击开放API，便可以看到说明。showdoc_api.sh⽣成的⽂档会放进你填写的这个项⽬⾥。除了api_key 和 api_token ，还有⼀个url 变量。如果是使⽤ ，则不需要修改。如果是使⽤开源版showdoc，则需要将地址改为，其中，别忘记了url⾥含server⽬录。
填写完毕，保存。然后直接双击运⾏，脚本会⾃动递归扫描本⽬录和⼦⽬录的所有⽂本代码⽂件，并⽣成API⽂档。
为了⽅便测试，官⽅还提供了⼀个例⼦。请下载：
下载后，把st⽂件放在showdoc_api.sh所在的⽬录或者⼦⽬录下。运⾏的时候它便会⽣成⽂档到你指定的项⽬地址中。
如果你想参考官⽅demo是怎么写的，可⽤⿏标右击st，选择编辑。仿照此种写法，在你的项⽬中插⼊类似的注释，也能达到⾃动⽣成⽂档的效果。详细语法会在⽂章后⾯部分说明。
如果你想应⽤到其他项⽬，可以把showdoc_api.sh复制⼀份到其他项⽬中。使⽤⽅法和前⾯⼀样。
Linux/Mac下使⽤指引
先cd进⼊你的项⽬⽬录，命令⾏模式下输⼊：
wget /script/showdoc_api.sh
下载完毕，编辑
vi showdoc_api.sh
脚本内容的前⾯有两个变量，api_key 和 api_token ，这个需要⽤户⾃⾏填写。关于这两个变量的取值，请登录showdoc，进⼊某个项⽬的设置，点击开放API，便可以看到说明。showdoc_api.sh⽣成的
⽂档会放进你填写的这个项⽬⾥。除了api_key 和 api_token ，还有⼀个url 变量。如果是使⽤ ，则不需要修改。如果是使⽤开源版showdoc，则需要将地址改为，其中，别忘记了url⾥含server⽬录。
保存⽂件后。执⾏以下命令，脚本会⾃动递归扫描本⽬录和⼦⽬录的所有⽂本代码⽂件，并⽣成API⽂档。
1. chmod +x showdoc_api.sh
2. ./showdoc_api.sh
为了⽅便测试，官⽅还提供了⼀个例⼦。请下载：
wget /script/st
下载后，把st⽂件放在showdoc_api.sh所在的⽬录或者⼦⽬录下。运⾏的时候它便会⽣成⽂档到你指定的项⽬地址中。
如果你想参考官⽅demo是怎么写的，可⽤vi命令打开st。仿照此种写法，在你的项⽬中插⼊类似的注释，也能达到⾃动⽣成⽂档的效果。详细语法会在⽂章后⾯部分说明。
如果你还想应⽤到其他项⽬，可以把showdoc_api.sh复制⼀份到其他项⽬中。使⽤⽅法和前⾯⼀样。
或者不转移位置，直接通过参数指定扫描⽬录。如
./showdoc_api.sh /myapp/demo/
语法说明
接口文档怎么看
⼀个标准语法例⼦：
1. /**
2. * showdoc
3. * @catalog 测试⽂档/⽤户相关
4. * @title ⽤户登录
5. * @description ⽤户登录的接⼝
6. * @method get
7. * @url /home/user/login
8. * @param username 必选 string ⽤户名
9. * @param password 必选 string 密码
10. * @param name 可选 string ⽤户昵称
11. * @return {"error_code":0,"data":{"uid":"1","username":"12154545","name":"吴系挂","groupid":2,"reg_time":"1436864169","last_login_time":"0"}}
12. * @return_param groupid int ⽤户组id
13. * @return_param name string ⽤户昵称
14. * @remark 这⾥是备注信息
15. * @number 99
16. */
关键
说明
字
⽣成⽂档要放到哪个⽬录。如果只是⼆级⽬录，则直接写⽬录名字。如果是三级⽬录，⽽需要写⼆级⽬录/三级⽬录，即⽤/隔开。
如”⼀层/⼆层/三层”
表⽰⽣成的⽂档标题
是⽂档内容中对接⼝的描述信息
接⼝请求⽅式。⼀般是get或者post
接⼝URL。不要在URL中使⽤&符号来传递参数。传递参数请写在参数表格中
参数表格说明。⼀⾏注释对应着表格的⼀⾏。⽤空格或者tab符号来隔开每⼀列信息。
可选。当请求参数是json的时候，可增加此标签。请把json内容压缩在同⼀⾏内。
返回内容。请把返回内容压缩在同⼀⾏内。如果是json，程序会⾃动进⾏格式化展⽰。如果是⾮json内容，则原样展⽰。
返回参数的表格说明。⼀⾏注释对应着表格的⼀⾏。⽤空格或者tab符号来隔开每⼀列信息。
备注信息
可选。⽂档的序号。

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。