一、准备工作
本文使用的是apipost2.0的插件,具体安装教程可以查看官方的文档
按照官方的教程来,可以很轻松地完成准备工作,以下是我出现的一些问题。
二、方法注释错误
根据官方的文档可以知道,我们有一些东西是必填的
其他没有问题,就是方法注释的模版需要调整一下,具体可以根据一些博客设置。
设置完之后,就可以符合官方的规范了。
三、传参对象的属性注释
上图的TbAccountDTO
的属性千万不要像下图这样使用单行注释,否则接口文档会获取不到注释
正确做法是使用段落注释:
段落注释的模范如下图:
四、测试
编写测试接口
我这里是给插件加了快捷键,一键上传
可以看到上传成功了,注释也是完整的
3q-1694682737393)]
可以看到上传成功了,注释也是完整的