apidoc文档生成器

最新推荐文章于 2023-04-14 13:34:02 发布

前端小li

最新推荐文章于 2023-04-14 13:34:02 发布

阅读量183

点赞数

分类专栏：前端文章标签： node.js api

本文链接：https://blog.youkuaiyun.com/HTML5_student/article/details/120070281

版权

前端专栏收录该内容

32 篇文章

订阅专栏

本文介绍了如何使用apidoc工具生成API文档，包括配置文件的编写、语言设置、接口注释的编写方法，并展示了如何在Node.js路由中应用注释。重点讲解了将forceLanguage设置为zh_cn以支持中文文档。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1.npm install apidoc -g
2.apidoc -i ./ -o ./aaa
apidoc -i 后是编译哪一个文件目录 ./是当前文件 -o 后是编译到哪个目录下 aaa目录下

3.在根目录下创建一个apidoc.json
注意一些版本的apidoc中forceLanage得设置为zh_cn 而不是zh-cn

{
    "name": "测试",
    "version": "0.0.1",
    "description": "API文档测试",
    "title": "API文档测试",
    "url" : "http://xxxxxxx",
    "sampleUrl" : "http://xxxxxxxx",
    "template":{
      "forceLanguage":"zh_cn"
    }
  }

4.在写好的api接口上面写上注释就好，
然后在执行第二步的命令

/**
 * @api {post} /user/login 用户登录
 * @apiName login
 * @apiGroup user
 * @apiParam {String} us 用户名
 * @apiParam {String} ps 用户密码 
 * 
*/
router.post('/login',(req,res)=>{
     let {us,ps} = req.body
     if(!us||!ps){ return res.send({code:-1,msg:'参数错误'})}
     //{us:us,ps:ps}==={us,ps}
     User.find({us,ps}).then((data)=>{
        console.log(data)
        if(data.length>0){
            res.send({code:200,msg:'登陆成功'})
        }else{
            res.send({code:-1,msg:'用户名或密码不正确'})
        }
     }).catch((err)=>{
        res.send({code:-1,msg:'内部错误'})
     })
    })

效果图
在这里插入图片描述