swagger 接口参数顺序_swagger扩展为按代码定义顺序展示接口和字段

1. 存在的问题

我们在项目中使用swagger2.0时，发现如下问题：

我们想要按字段排序必须显示声明排序字段@ApiModelProperty(position=0)

swagger对注解@ApiOperation不支持position属性了，即不能按照指定接口顺序排序。(ps:官方也不提供解决，说设计如此，通过接口地址来排序。链接)

2.解决方法

查询官网

使用对应的扩展插件(ModelPropertyBuilderPlugin、OperationBuilderPlugin)

2.1使用ModelPropertyBuilderPlugin按代码顺序展示请求和响应字段

可以参考ModelPropertyBuilderPlugin的实现类ApiModelPropertyPropertyBuilder来实现自己的插件，

大概实现思路为：获取到字段上有ApiModelProperty注解的字段所在的类，然后获取所有字段数组，看这个字段在数组的哪个位置，就设置position属性。

实现代码如下：

/**

* 通过编写插件实现字段按类变量定义顺序排序,丰富模型属性

@Component

public class CustomApiModelPropertyPositionBuilder implements ModelPropertyBuilderPlugin {

private Log log = LogFactory.getLog(getClass());

@Override

public boolean supports(DocumentationType

swagger 接口参数顺序_swagger扩展为按代码定义顺序展示接口和字段相关推荐

计算机接口参数在哪儿看,怎么看笔记本cpu接口参数
很多用户购买了CPU后,都想查看有关信息,那如何查看CPU接口参数呢?下面是学习啦小编为大家介绍笔记本电脑CPU接口参数的查看方法,欢迎大家阅读. 笔记本电脑CPU接口参数的查看方法目前市场上见到比 ...
java类定义的顺序_Java类及对象的初始化顺序
1.初始化规则: 下面规则优先级从前往后依次降低 0.加载一个类时先初始化基类后初始化扩展类: 1.类的初始化高于对象的初始化: 类的初始化依靠静态代码(被static标识的),静态代码块.静态变量这 ...
java类编来那个初始化顺序_Java类及对象的初始化顺序
1.初始化规则: 下面规则优先级从前往后依次降低 ①.加载一个类时先加载初始化基类后加载初始化扩展类: ②.类的初始化高于实例的初始化: 类的初始化依靠(静态代码块static{....})以及(静态 ...
java类的运行顺序_Java语言类的基本运行顺序
本文主要向大家介绍了Java语言类的基本运行顺序,通过具体的代码向大家展示,希望对大家学习Java语言有所帮助.我们以下面的类来说明一个基本的 Java 类的运行顺序:1. public class ...
php开发视频播放顺序,请问关于php代码运行顺序问题
麻烦会的朋友帮忙回答下以下的问题, 谢谢啦. 在网上下载了套代码. 如下 admin.php 文件: 对于以下这段代码, 究竟代码是怎么跑的呢? 也就是比如说以下的代码,什么时候才会跑 if ( ...
swagger 接口参数顺序_Swagger常用参数用法 - mao2080 - 博客园
别提示:本人博客部分有参考网络其他博客,但均是本人亲手编写过并验证通过.如发现博客有错误,请及时提出以免误导其他人,谢谢!欢迎转载,但记得标明文章出处: http://www.cnblogs.com/ ...
偏前端 - vue-cli(axios请求数据==》token+按接口参数顺序（参数值拼接base64）- MD5)...
token+按接口参数顺序(参数值拼接base64)-> MD5) 请教于"喵咪",再此特别鸣谢!~ 特别强调:import qs from qs; 这个内部方法一定要用哦. ...
Swagger使用————接口参数注解的使用缺陷
问题描述在使用springboot开发web项目时,用到了swagger框架,来生成web api文档.但是其中有一项是举例说明参数的结构,如下图: 但是,这个功能真的是非常方便,因为可以让前端开发 ...
SpringBoot2 | Spring IOC 流程中核心扩展接口的12个扩展点源码分析（十一）
微信公众号:吉姆餐厅ak 学习更多源码知识,欢迎关注. SpringBoot2 | SpringBoot启动流程源码分析(一) SpringBoot2 | SpringBoot启动流程源码分析(二) ...

swagger 接口参数顺序_swagger扩展为按代码定义顺序展示接口和字段

swagger 接口参数顺序_swagger扩展为按代码定义顺序展示接口和字段相关推荐

最新文章

热门文章