当前位置: 首页 > news >正文

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

http://www.lryc.cn/news/263222.html

相关文章:

  • js多图合成一张图
  • 利用原始套接字解决mac地址错误问题【南瑞SysKeeper-2000】
  • JVM- 为什么G1垃圾回收器需要有大对象区
  • 操作系统的界面
  • User 怎么在anaconda的虚拟环境中安装下载好的jieba.tar.gz包呢
  • 1.【分布式】分布式事务详解
  • selenium-wire简介
  • 华为组播配置案例
  • lua语法
  • 5A-Downloader,m3u8文件转mp4文件,音视频分离ts合并、转mp4
  • 标准IO与文件IO
  • 流行的 React 相关库和框架
  • 游戏引擎?
  • C语言--字符函数与字符串函数
  • 整理了一些热门、含免费次数的api,分享给大家
  • Wireshark在网络性能调优中的应用
  • 关于设计师的自我评价(合集)
  • Hudi Clustering
  • 通过与 Team Finance 整合,Casper Network 让 Token 的创建、部署更加高效
  • Linux软件管理rpm和yum
  • uart和usart的区别
  • 原生微信小程序-使用 阿里字体图标 详解
  • 机器学习 | 机器学习基础知识
  • OpenHarmony鸿蒙原生应用开发,ArkTS、ArkUI学习踩坑学习笔记,持续更新中。
  • RHCE8 资料整理(十)二
  • CUDA 学习记录2
  • 探索Qt 6.3:了解基本知识点和新特性
  • 持续集成交付CICD:基于 GitLabCI 与 JenkinsCD 实现后端项目发布
  • 一些好用的VSCode扩展
  • 3dsmax渲染太慢,用云渲染农场多少钱?