idea使用apipost插件

一、准备工作

本文使用的是apipost2.0的插件,具体安装教程可以查看官方的文档

按照官方的教程来,可以很轻松地完成准备工作,以下是我出现的一些问题。

二、方法注释错误

根据官方的文档可以知道,我们有一些东西是必填的

image-20230914165256474

其他没有问题,就是方法注释的模版需要调整一下,具体可以根据一些博客设置。

设置完之后,就可以符合官方的规范了。

image-20230914165638088

三、传参对象的属性注释

上图的TbAccountDTO的属性千万不要像下图这样使用单行注释,否则接口文档会获取不到注释

正确做法是使用段落注释:

image-20230914165836254

段落注释的模范如下图:

image-20230914165922870

四、测试

编写测试接口

image-20230914170635244

我这里是给插件加了快捷键,一键上传

image-20230914170723091

可以看到上传成功了,注释也是完整的

3q-1694682737393)]

可以看到上传成功了,注释也是完整的

image-20230914170932371

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值