swagger ui 自動添加全局header請求頭參數,用戶自動填寫api簽名等需求


@Configuration
@EnableSwagger2
public class SwaggerConfig {
 
 
    @Bean
    public Docket createRestApi() {
        ParameterBuilder aParameterBuilder = new ParameterBuilder();
        aParameterBuilder.name("X-Emp-Id").description("userId").modelRef(new ModelRef("int")).parameterType("header").required(true).build();
        ParameterBuilder aParameterBuilder1 = new ParameterBuilder();
        aParameterBuilder1.name("X-Emp-No").description("userCode").modelRef(new ModelRef("String")).parameterType("header").required(true).build();
        List<Parameter> aParameters = new ArrayList<Parameter>();
        aParameters.add(aParameterBuilder.build());
        aParameters.add(aParameterBuilder1.build());
 
 
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("com.xx.xx")
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.xx.xx"))
                .paths(PathSelectors.any())
                .build()
                .useDefaultResponseMessages(false)
                .globalOperationParameters(aParameters);
    }
 
    private ApiInfo apiInfo() {
 
        return new ApiInfoBuilder()
                .title("xxx")
                .description("API文檔")
                .termsOfServiceUrl("https://xx.com.cn")
                .version("1.0")
                .build();
    }
}

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM