Swagger Starter用户,可以通过修改配置的方式:Swagger Tag 排序# Swagger Tag 排序swagger.ui-config.tags-sorter=alpha# Swagger 分组排序问题# 两个配置项# alpha<按字母表排序> # method<按方法定义顺序排序>swagger.ui-config.operati...
之前通过Spring Boot 2.x基础教程:使用
Swagger
2构建强大的API文档一文,我们学习了如何使用
Swagger
为Spring Boot项目自动生成API文档,有不少用户留言问了关于文档内容的组织以及
排序
问题。所以,就特别开一篇详细说说
Swagger
中文档内容如何来组织以及其中各个元素如何控制前后
顺序
的具体配置方法。
接口
的分组
我们在Spring Boot中定义各个
接口
是以Controller作为第一级维度来进行组织的,Controller与具体
接口
之间的关系是一对多的关系。我们可以将同
package com.hfvast.east_olympic.config;
import io.
swagger
.models.parameters.Parameter;
import org.springframework.context.annotation.Primary;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.sp
以前开发的是
接口
对接前端,,发现
swagger
入参、出参
顺序
是按照
参数
名首字母排的,这就比较乱,比如两个时间
参数
startTime、endTime,即便在对象DTO中定义的挨着,到
swagger
-ui却差了八里地,最近做了个项目,API的,没有前端对接了,产品成型就是API
接口
,用户是直接查看
swagger
做参考的,这种乱序直接被产品打了回来,看了下
swagger
文档,其实固定
顺序
很简单,只需要在注解后面加个属性,如图
声明!声明!声明!如果没有做其他配置的话,按照下方的配置肯定可以用,但是如果有其他配置的话我就不敢保证了,
Swagger
迭代的挺快的,不同版本之间的配置也略有不同。
第一步:引入依赖
注意:直接复制,不要
修改
版本
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-
swagger
2</artifactId>
<version>
.globalOperationParameters(getGlobalOperationParameters())
@Bean
public Docket createRestApi() {
Docket docket = new Docket(DocumentationType.
SWAGGER
_2)
.apiInfo(...
swagger
升级到3.0了,看似比较方便,但其实有很多坑啊!首先就是
排序
问题
属性
排序
升级到3.0后,ApiModelProperty的position 属性失效了!这就很坑啊!谁给你们的自信去掉这个
排序
的,哪有人会照着首字母
排序
的!我也是醉了!
@ApiModelProperty(position = 1)
属性为List时,只显示一个元素
我也是醉了,咱弄了一个list,肯定是要放多个元素啊,不然我直接放个对象就号了,为什么要放一个list呢!
然后这个直接固定写死一个List[0],也没有地方添
<groupId>io.springfox</groupId>
<artifactId>springfox-
swagger
2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>