大家使用swagger往往會和JWT一起使用，而一般使用jwt會將token放在head里，這樣我們在使用swagger測試的時候并不方便，因為跨域問題它默認不能自定義head參數。然后自己去網上找，發現國內大多數的都是寫一個Filter接口，然后添加到配置。這樣極大的破壞了程序的完整性。想想這相當于維護兩套代碼。我們只是需要一個簡單的小功能，國外大多是修改Swagger的index頁面，而我用的是swagger2，不需要配置靜態的那些東西。

所以我在SwaggerConfig.api()方法中添加了前4行代碼，然后調用.globalOperationParameters(pars)方法將head參數添加進去：

@EnableSwagger2 @EnableWebMvc @ComponentScan("com.g.web") public class SwaggerConfig {@Beanpublic Docket api(){//添加head參數startParameterBuilder 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參數endreturn 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端人員調用server端接口的測試文檔與平臺").version("1.0.0").termsOfServiceUrl("http://terms-of-services.url")//.license("LICENSE")//.licenseUrl("http://url-to-license.com").build();} }

然后前臺效果是這樣的：

?

?

如果有問題請在下面留言

大家可關注我的微信公眾號：裸睡的豬，后期會為大家推薦更多有用的文章！

總結

以上是生活随笔為你收集整理的Swagger2 添加HTTP head参数的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。