大家使用swagger往往會和JWT一起使用断箫，而一般使用jwt會將token放在head里棒仍，這樣我們在使用swagger測試的時候并不方便，因為跨域問題它默認不能自定義head參數(shù)。然后自己去網(wǎng)上找衔蹲，發(fā)現(xiàn)國內(nèi)大多數(shù)的都是寫一個Filter接口，然后添加到配置呈础。這樣極大的破壞了程序的完整性舆驶。想想這相當(dāng)于維護兩套代碼。我們只是需要一個簡單的小功能猪落，國外大多是修改Swagger的index頁面贞远，而我用的是swagger2，不需要配置靜態(tài)的那些東西笨忌。
所以我在SwaggerConfig.api()方法中添加了前4行代碼蓝仲，然后調(diào)用.globalOperationParameters(pars)方法將head參數(shù)添加進去：
@EnableSwagger2
@EnableWebMvc
@ComponentScan("com.g.web")
public class SwaggerConfig {
@Bean
public Docket api(){
//添加head參數(shù)start
ParameterBuilder tokenPar = new ParameterBuilder();
List<Parameter> pars = new ArrayList<Parameter>();
tokenPar.name("x-access-token").description("令牌").modelRef(new ModelRef("string")).parameterType("header").required(false).build();
pars.add(tokenPar.build());
//添加head參數(shù)end
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.any())
.paths(PathSelectors.regex("/api/.*"))
.build()
.globalOperationParameters(pars)
.apiInfo(apiInfo());
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("后臺接口文檔與測試")
.description("這是一個給app端人員調(diào)用server端接口的測試文檔與平臺")
.version("1.0.0")
.termsOfServiceUrl("http://terms-of-services.url")
//.license("LICENSE")
//.licenseUrl("http://url-to-license.com")
.build();
}
}
然后前臺效果是這樣的：
swagger.png
轉(zhuǎn)自: 昌昌93
