showdoc使用(图文教程)

近日发现一个好用的接口文档生成工具——showdoc

以下是图文教程

本文章使用的为showdoc与runapi的win版客户端，该工具提供网页版，操作方法大体相同，故不单独介绍。

一、showdoc

1.新建项目

2.生成api的key与token

3.将脚本文件放入接口的代码文件同级目录，或多个接口文件夹的上级目录（扫描文件数越多，耗时越长）

4.代码示例

因为自动生成需要借助于代码注释完成，所以在注释的书写时较为耗费时间，可以将注释设置为快速模板使用。

5.修改sh脚本的key与token

6.运行（由于windows不能直接运行.sh文件，借助git实现脚本运行）

7.查看生成的文档

1.新建项目

2.填写请求信息

3.发送请求，获取响应（可不在此步复制响应）

4.快速生成相关信息

5.保存文件

6.回到同账号的showdoc，可以找到刚刚生成的文档（showdoc不支持修改runapi生成的文件）

7.成功生成文件

ps：showdoc提供私有化部署方案：如果你有自己的服务器，可前往showdoc官网查看详情

就到这里了，下次见