Showdoc使用——接口文档

野性酷女 2023-10-01 20:42 35阅读 0赞

### 一、到showdoc官方注册账号 ###

官方地址[https://www.showdoc.com.cn/][https_www.showdoc.com.cn]  
登录并创建一个项目,如图：

![img][]

### 二、下载showdoc环境 ###

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

![img][img 1]

其中就是官方教程，简单全面。showdoc基础就是使用官方脚本  
[https://git-scm.com/download/win][https_git-scm.com_download_win]国内：这些都是showdoc官方推荐的，先安装git再下载showdoc脚本。

### 三、配置 ###

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

### 四、运行 ###

首先再接口头部写上注释，参考：  
/\*\*  
\* showdoc  
\* @catalog 测试文档/用户相关  
\* @title 用户登录  
\* @description 用户登录的接口  
\* @method get  
\* @url [https://www.showdoc.cc/home/user/login][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脚本，然后就可以再自己showdoc工作台的项目中看见接口了，示例：

![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBAQXJjaGllX2phdmE_size_20_color_FFFFFF_t_70_g_se_x_16]

[https_www.showdoc.com.cn]: https://links.jianshu.com/go?to=https%3A%2F%2Fwww.showdoc.com.cn%2F
[img]: https://img-blog.csdnimg.cn/img_convert/055f7ae2da2797a4e5e2faf09bfcb0f8.png
[img 1]: https://img-blog.csdnimg.cn/img_convert/d4ccd15c672d89266b8de9d1f6418eb5.png
[https_git-scm.com_download_win]: https://links.jianshu.com/go?to=https%3A%2F%2Fgit-scm.com%2Fdownload%2Fwin
[url_https_www.showdoc.com.cn_server_s_api_open_fromComments]: https://links.jianshu.com/go?to=https%3A%2F%2Fwww.showdoc.com.cn%2Fserver%2F%3Fs%3D%2Fapi%2Fopen%2FfromComments
[http_xx.com_server_index.php_s_api_open_fromComments]: https://links.jianshu.com/go?to=http%3A%2F%2Fxx.com%2Fserver%2Findex.php%3Fs%3D%2Fapi%2Fopen%2FfromComments
[https_www.showdoc.cc_home_user_login]: https://links.jianshu.com/go?to=https%3A%2F%2Fwww.showdoc.cc%2Fhome%2Fuser%2Flogin
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBAQXJjaGllX2phdmE_size_20_color_FFFFFF_t_70_g_se_x_16]: https://img-blog.csdnimg.cn/73f20f3fac034cdeba4dbb0ad5d75d3f.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBAQXJjaGllX2phdmE=,size_20,color_FFFFFF,t_70,g_se,x_16