IDEA添加Apifox插件后,返回参数不详细解决办法

Apifox官方文档地址(文档中返回的是特殊情况,跟我现在项目的返回不一样,因此需要更改配置)
点击跳转到官方API地址
实现步骤分为两步:第一步:添加配置,第二步使用注解。

1.添加配置

打开Idea设置,添加配置文件:File->setting->Apifox Helper->自定义规则

IDEA添加Apifox插件后,返回参数不详细解决办法_第1张图片
####内容:method.return[#return]=groovy: helper.resolveLink(it.doc("return"))
我的接口返回的格式如下图:我返回的是Result里中包含OnlineTraining这个对象

IDEA添加Apifox插件后,返回参数不详细解决办法_第2张图片
OnlineTraining部分代码展示
IDEA添加Apifox插件后,返回参数不详细解决办法_第3张图片
Result:根据自己自定义返回格式设置就行
我的自定义的Result大致展示:
IDEA添加Apifox插件后,返回参数不详细解决办法_第4张图片

2.使用注解

在自己的接口上添加注解,注解由4个部分组成:1.接口描述信息,2.@return,3.@link,4.要返回的对象参数
/**
     * 根据id查询课程详情
     *
     * @return {@link OnlineTraining}
     */

代码截图展示:
IDEA添加Apifox插件后,返回参数不详细解决办法_第5张图片

配置好以上内容后继续以下操作

更新文档到Apifox
IDEA添加Apifox插件后,返回参数不详细解决办法_第6张图片
控制台:
IDEA添加Apifox插件后,返回参数不详细解决办法_第7张图片

进入Apifox桌面应用,刷新文档
IDEA添加Apifox插件后,返回参数不详细解决办法_第8张图片
特别注意:=============================================================================
如果在之前没有配置的时候就已经将文档更新到Apifox上了,建议在Apifox桌面应用程序中删除对应的接口和数据模型,再重新上传。我就是因为没有删除导致一直返回不正确。
IDEA添加Apifox插件后,返回参数不详细解决办法_第9张图片
没有配置之前返回参数展示:
IDEA添加Apifox插件后,返回参数不详细解决办法_第10张图片
配置之后返回参数展示:
IDEA添加Apifox插件后,返回参数不详细解决办法_第11张图片
特别感谢我的好友 @孟之源 指正才成功解决这个问题

你可能感兴趣的:(java,Apifox,idea)