1.安装模块 全局安装 -g / --global
yarn add apidoc --global
2.给项目package.json配置
"apidoc": {
"title": " admin pro",
"url" : "http://localhost:3001/"
}
3.在接口上面编写接口文档
文档接口前配置如下的类似代码
/**
* @api {get} /api/nav/navcategory 获取导航分类
* @apiName GetNavCategory
* @apiGroup Nav
*
* @apiSuccess {String} code 状态码.
* @apiSuccess {String} message 描述
* @apiSuccess {String} data 数据
*
* @apiSuccessExample Success-Response:
* HTTP/1.1 200 OK
* {
* "code": "200",
* "message": "导航的分类数据",
* "data": []
* }
* @apiSampleRequest /api/nav/navcategory
*/
router.get('/navcategory', (req, res, next) => {
sql.find(Navcategory, {}, { _id: 0, __v: 0 }).then(data => {
res.status('200').send({
code: '200',
message: '导航的分类数据',
data
})
})
})
module.exports = router
保存 apidoc
apidoc -i api/ -o public/apidoc
apidoc 是命令
-i 表示下载
api/空格 该接口所在的文件夹（api） 下面所有的（写的接口）文件 (f范围）
-o 表示 output 输出到
public/apidoc public下面的apidoc文件夹
每次修改后 都运行这个命令 就可以保存了
访问接口文档 http:localhost:3001/apidoc 就可以看到了 （具体看自己项目设置的端口号）
文档展示
image.png
