apidoc的使用和常见问题的解决办法
作者:程序员11 时间:2023-04-14 人气:158 QQ交流群\邮箱:1003265987@qq.com遇到的问题,还得自己来抠,这个apidoc是通过后台写接口的注释来达到自动生成接口文档的作用。
apidoc是基于node使用的,所以具体安装方法请参考:https://www.cnblogs.com/minsons/articles/7154090.html
安装和使用这里我就不做过多介绍了,网上一搜一大堆,我这里主要说一下遇到的问题吧:
1.当我们想把多个文件生成一个文档的时候,这时要注意分组了,如果你想要所有接口写在一个分组下,可以这样写:
/**
* @apiDefine GroupName 小程序-仓库管理
*/
/**
* @api {post} /WareHouses/index 获取仓库数据
* @apiName 仓库数据
* @apiGroup GroupName
* @apiVersion 1.0.0
但是,在多个文件同时生成一个文档时,不同文件是不同的模块,需要在不同的分组里,这样的操作,生成文档会有遗漏的接口没有生成文档,就像这样客户的接口跑到了仓库的分组里,因为不同文件里可能会存在相同的方法名,这样生成的文档会乱,怎样解决这个问题呢?请往下看:
首先找到api_group.js,一般是在C:UsersAdministratorAppDataRoaming pm ode_modulesapidoc ode_modulesapidoc-corelibworkersapi_group.js(或者在 ode_modulesapidoclibcoreworkers) 然后把//group = group.replace(/[^w]/g, '_');这行代码注释掉,这行代码的意思是分组名可以用中文显示,回到接口文件去掉统一定义的:
/**
* @apiDefine GroupName 小程序-仓库管理
*/
把每个接口的apidoc注释中的:
* @apiGroup 小程序-仓库管理
都改成当前接口的分组名,这样多个文件同时生成一个接口文档就可以了,
欢迎阅读本文章,觉得有用就多来支持一下,没有能帮到您,还有很多文章,希望有一天能帮到您。