swagger測試帶token的請求

大家使用swagger往往會(huì)和JWT一起使用,而一般使用jwt會(huì)將token放在head里,這樣我們在使用swagger測試的時(shí)候并不方便,因?yàn)榭缬騿栴}它默認(rèn)不能自定義head參數(shù)。然后自己去網(wǎng)上找,發(fā)現(xiàn)國內(nèi)大多數(shù)的都是寫一個(gè)Filter接口,然后添加到配置。這樣極大的破壞了程序的完整性。想想這相當(dāng)于維護(hù)兩套代碼。我們只是需要一個(gè)簡單的小功能,國外大多是修改Swagger的index頁面,而我用的是swagger2,不需要配置靜態(tài)的那些東西。

所以我在SwaggerConfig.api()方法中添加了前4行代碼,然后調(diào)用.globalOperationParameters(pars)方法將head參數(shù)添加進(jìn)去

@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("后臺(tái)接口文檔與測試")
            .description("這是一個(gè)給app端人員調(diào)用server端接口的測試文檔與平臺(tái)")
            .version("1.0.0")
            .termsOfServiceUrl("http://terms-of-services.url")
            //.license("LICENSE")
            //.licenseUrl("http://url-to-license.com")
            .build();
    }
}

然后前臺(tái)效果是這樣的:

image
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容