apidoc⾃动化⽣成api接⼝⽂档
⼿写api接⼝太⿇烦. 学习了apidoc⾃动⽣成接⼝⽂档，这边做⼀下整理
要⽤组件那就必须先安装 apidoc，做⼀下全局安装
npm install apidoc -g
新建配置⽂件apidoc.json
{
"name":"test-server",
"version":"1.0.0",
"description":"测试API⽂档",
"title":"test-server API",
"url":"127.0.0.1:3000",
"forceLanguage":"zh-cn"
百度api接口}
在要存放接⼝⽂档的⽬录下创建⼀个 apidoc 空⽬录,⽤来存放⽣成的接⼝⽂件，我是放在public⽬录下
写api的接⼝注释 ，如上图右侧注释部分，相关解释可去官⽹ apidocjs 查看或者⾃⼰摸索⼀下
/**
* @api {post} /postUser 测试api
* @apiDescription 测试api
* @apiName text
* @apiGroup User
* @apiParam {string} account ⽤户账号
* @apiParam {string} password ⽤户密码
* @apiHeader {String} Authorization  ⽤户授权token
* @apiSuccess  msg 返回消息
* @apiSuccessExample {json} Success-Response:
*  {
code : 200,
msg: '认证token成功',
}
* @apiSampleRequest 127.0.0.1:3000/postUser
* @apiVersion 1.0.0
*/
最后⼀步就是⽣成api接⼝⽂档 ，在项⽬下执⾏命令:-i 指输⼊对 routes⽬录下⽂件进⾏编译 -o指输出输出到public/apidoc⽬录下
apidoc -i routes/ -o public/apidoc/
项⽬运⾏起来，在浏览器输⼊api接⼝⽂档的浏览地址，就能看到⾃动⽣成的接⼝⽂档了

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。