用用APIDOC这个东西

本文主要是介绍用用APIDOC这个东西，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

1. 安装node.js
2. 安装apiDoc

npm install apidoc -g

会比较慢，切换一下源。

新建apidoc.json如下内容

{"name": "接口文档名字","version": "1.0.0","description": "apiDoc for xxx 1.0.0","title": "接口文档1.0.0","url" : "拼接接口文档的默认路径url/api/b/"
}

一些其他标签的解释https://apidocjs.com/#install  文档里面有

每个控制器上面写一个/**** @apiDefine Product 产品*//**** @api               {get} /products/get-list 产品列表* @apiGroup          Product** @apiParam {int} page 当前页* @apiParam {int} per_page 每页显示条数* @apiParam {array} [product_status] 产品状态  [] 非必填** @apiSuccess        {String} code 标识码 1-成功 其他-失败* @apiSuccess        {String} msg  响应信息* @apiSuccess        {Array}  data 数据包** @apiSuccessExample Success-Response:* {"code":1,"msg":"\u64cd\u4f5c\u6210\u529f","data":{}}*/

 在json目录，

执行 apidoc -i .\app\代码目录\ -o ..\api-book生成文档目录\

 

这篇关于用用APIDOC这个东西的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！

---