如何使用apiDoc

最近对后端同学的接口文档很感兴趣，抽空学习了下~

1、安装nodeJs

2、安装和使用apiDoc

  新建一个文件夹，打开终端：

npm install apidoc -g

 

把api注释写在你要调用的接口上方

 

 

具体含义参考官网：

https://apidocjs.com/#param-api-sample-request

@api

@api {method} path [title]

接口方法、路径和名称

@apiGroup 

@apiGroup name

接口分组

 @apiParam 

@apiParam [(group)] [{type}] [field=defaultValue] [description]

接口参数

 @apiSuccessExample

@apiSuccessExample [{type}] [title]
                   example

请求成功返回样例

@apiErrorExample

@apiErrorExample [{type}] [title]
                 example

请求失败返回样例

写完之后执行：

apidoc -i src/ -o apidoc

-i 后是你api所在的目录，-o 后是生成的api文档所在目录

 

3、完成

执行后自动生成apidoc 目录，打开index.html,就看到生成文档啦！

参考：

后端接口文档书写教程

apiDoc 使用指南