# 3.7 分组排序

WARNING

增强功能需要通过配置yml配置文件开启增强,自2.0.7开始

knife4j:
  enable: true

Controller之间的排序主要有两种方式,排序的规则是倒序,但是排序的最小值必须大于0

建议优先级是:@ApiSupport>@ApiSort>@Api

对于最高级别的值,可以从999开始

@ApiSupport注解自2.0.3版本引入

第一种,使用@ApiSupport注解中的属性order,代码示例如下:

@Api(tags = "2.0.3版本-20200312")
@ApiSupport(order = 284)
@RestController
@RequestMapping("/api/nxew203")
public class Api203Constroller {
    
    
}

第二种情况,使用knife4j提供的增强注解@ApiSort,代码示例如下:

@Api(tags = "2.0.2版本-20200226")
@ApiSort(286)
@RestController
@RequestMapping("/api/nxew202")
public class Api202Controller {
    
    
}

第三种,使用注解@Api中的属性position(需要注意的是该属性以及过时,建议开发者使用第一种),代码示例如下:

@Api(tags = "2.0.2版本-20200226",position = 286)
@RestController
@RequestMapping("/api/nxew202")
public class Api202Controller {
    
    
}

接口排序规则一样,Knife4j也是通过Spring Plugin插件化的方式,扫描接口注解,最终通过扩展OpenAPI的扩展属性x-order进行赋值,最终在Ui界面中解析,然后再进行排序后渲染组件

最终在OpenAPI的结构如下:

开发者如果遇到排序不生效的问题,可以通过检查接口返回的OpenAPI规范中,分组tag节点下是否包含x-order的扩展属性

被围观 人次
上次更新: 2020-11-6 20:20:48
有任何问题请使用Knife4j的标签在OSC社区