增強(qiáng)功能

SwaggerBootstrapUi自1.8.5版本以后,增加了后端Java代碼的支持功能,主要目的是輔助Java開發(fā)者在使用Springfox-Swagger的同時(shí),擴(kuò)展一些增強(qiáng)功能，幫助開發(fā)者擁有更好的文檔體驗(yàn).

目前主要增強(qiáng)功能：

• tags分組標(biāo)簽排序
• api接口排序

使用swagger-bootstrap-ui提供的增強(qiáng)功能,需要在源Spring的config配置文件中開啟,在原EnableSwagger2注解上增加@EnableSwaggerBootstrapUi注解，示例代碼如下：

@Configuration
@EnableSwagger2
@EnableSwaggerBootstrapUI
public class SwaggerConfiguration {
    //more...   
}

針對(duì)tags分組排序，UI的排序規(guī)則是順序排序，最小值1，最大值也是默認(rèn)值Integer.Max_VALUE;

如果不使用SwaggerBootstrapUi的增強(qiáng)功能,則無需開啟@EnableSwaggerBootstrapUi注解

tags的排序規(guī)則分兩種：

a、一種是判斷Swagger的@Api注解的position屬性是否不等于0（默認(rèn)值為0），如果該值不為空,則獲取此值,根據(jù)該值排序

b、如果postion=0（不寫的情況下）,判斷是否存在注解@ApiSort的值，如果有值，則獲取此值,根據(jù)該值排序

c、所以排序的取值規(guī)則是：position>@ApiSort

接口api的排序規(guī)則：

a、判斷@ApiOperation注解上的postion屬性是否不等于0（默認(rèn)值為0），如果該值不為空,則獲取此值,根據(jù)該值排序

//postion屬性賦值
@ApiOperation(httpMethod = "POST",position = 2,value = "Test2Model測(cè)試數(shù)組參數(shù)，多個(gè)",response=Test2Model.class)
@ApiResponses({
    @ApiResponse(code = 200, message = "非HTTP狀態(tài)碼，返回值JSON code字段值，描述：成功")
})
@ApiImplicitParams({
    @ApiImplicitParam(name = "ids",paramType ="form",value = "參數(shù)",allowMultiple = true, required = true)
})

b、如果postion=0（不寫的情況下）,判斷是否存在注解@ApiOperationSort的值，如果有值，則獲取此值,根據(jù)該值排序

c、所以排序的取值規(guī)則是：position>@ApiOperationSort

注意：

注解@EnableSwaggerBootstrapUi、@ApiSort、@ApiOperationSort是本UI工具包提供的Java注解,排序功能的使用需要在啟用原EnableSwagger2注解上增加@EnableSwaggerBootstrapUi注解方可生效

以上后臺(tái)設(shè)置全部完成后,在UI的個(gè)性化設(shè)置中還需勾選開啟增強(qiáng)功能,否則增強(qiáng)功能不生效.

功能目錄：文檔管理 -> 個(gè)性化設(shè)置