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

2023-12-15 16:37:55

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

1.添加配置

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

在这里插入图片描述
####内容：method.return[#return]=groovy: helper.resolveLink(it.doc("return"))
我的接口返回的格式如下图：我返回的是Result里中包含OnlineTraining这个对象

在这里插入图片描述
OnlineTraining部分代码展示：
在这里插入图片描述
Result：根据自己自定义返回格式设置就行
我的自定义的Result大致展示：
在这里插入图片描述

2.使用注解

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

代码截图展示：
在这里插入图片描述

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

更新文档到Apifox
在这里插入图片描述
控制台：
在这里插入图片描述

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

文章来源:https://blog.csdn.net/qq_42991839/article/details/135017807
本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。