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

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桌面应用程序中删除对应的接口和数据模型,再重新上传。我就是因为没有删除导致一直返回不正确。
在这里插入图片描述
没有配置之前返回参数展示:
在这里插入图片描述
配置之后返回参数展示:
在这里插入图片描述
特别感谢我的好友 @孟之源 指正才成功解决这个问题

Apifox IDEA插件是一个用于在IDEA项目中快速生成API文档并同步到Apifox的工具。它可以解析Java、Kotlin和Scala的API文档,支持Swagger注解,并且可以导出Markdown格式的API文档。该插件基于easy-api进行定制开发,具有以下功能特性: 1. 导出API文档到Apifox。 2. 在IDEA中直接发起API请求。 为了使用该插件,你需要先下载并安装Apifox IDEA插件。你可以在以下链接中找到Apifox的下载路径:\[1\]。同时,你还需要下载并安装IDEA开发工具,你可以在以下链接中找到IDEA的绿色版:\[1\]。 安装成功后,你需要配置插件参数。在IDEA中,你可以通过以下步骤进行配置: 1. 打开IDEA,进入File -> Settings -> Plugins,搜索框中输入"Apifox Helper",点击安装插件。 2. 进入File -> Settings -> Apifox Helper,填写Apifox服务器地址、API访问令牌和模块项目ID配置。你可以在Apifox的官方网站上获取这些信息。\[2\] 配置完成后,你可以将IDEA内的项目与Apifox的项目进行关联,需要填写Apifox服务器地址、个人访问令牌和项目ID。你可以在IDEA的设置界面中找到这些配置项。\[3\] 通过使用Apifox IDEA插件,你可以更方便地生成和管理API文档,并与团队成员进行协作。希望这些信息对你有帮助! #### 引用[.reference_title] - *1* *2* [apifox 集成 idea2022.2.5 apifox配置自动登录token](https://blog.csdn.net/qq_28695333/article/details/129865985)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v91^control,239^v3^insert_chatgpt"}} ] [.reference_item] - *3* [Apifox IDEA 插件 | 帮助开发者快速生成 API 文档](https://blog.csdn.net/m0_71808387/article/details/129123445)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v91^control,239^v3^insert_chatgpt"}} ] [.reference_item] [ .reference_list ]
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值