目前主要增强功能:
- api接口排序
使用提供的增强功能,需要在源Spring的config配置文件中开启,在原EnableSwagger2
注解上增加@EnableSwaggerBootstrapUi
注解,示例代码如下:
针对tags分组排序,UI的排序规则是顺序排序,最小值1,最大值也是默认值Integer.Max_VALUE;
如果不使用SwaggerBootstrapUi的增强功能,则无需开启@EnableSwaggerBootstrapUi注解
tags的排序规则分两种:
b、如果postion=0(不写的情况下),判断是否存在注解@ApiSort的值,如果有值,则获取此值,根据该值排序
c、所以排序的取值规则是:position>@ApiSort
接口api的排序规则:
a、判断@ApiOperation注解上的postion属性是否不等于0(默认值为0),如果该值不为空,则获取此值,根据该值排序
@ApiResponses({
@ApiImplicitParams({
b、如果postion=0(不写的情况下),判断是否存在注解@ApiOperationSort的值,如果有值,则获取此值,根据该值排序
注意:
注解@EnableSwaggerBootstrapUi、@ApiSort、@ApiOperationSort是本UI工具包提供的Java注解,排序功能的使用需要在启用原EnableSwagger2注解上增加@EnableSwaggerBootstrapUi注解方可生效
以上后台设置全部完成后,在UI的个性化设置中还需勾选开启增强功能,否则增强功能不生效.
功能目录:文档管理 -> 个性化设置