1. 程式人生 > >SwaggerConfig 使用小技巧

SwaggerConfig 使用小技巧

@Configuration
@EnableSwagger2
@EnableAutoConfiguration
public class SwaggerConfig
{

    @Bean
    public Docket createRestApi() {
        ParameterBuilder tokenPar = new ParameterBuilder();
        //用來統一一些公用引數,這裡設定前端和後臺登入的輸入引數
        List<Parameter> pars = new ArrayList<Parameter>();
        tokenPar.name("sessionId")
                .description("登入令牌")
                .modelRef(new ModelRef("string"))
                .parameterType("header")  //引數型別為header中的引數
                .required(false)
                .build();

        ParameterBuilder tokenPar1 = new ParameterBuilder();
        tokenPar1.name("backSessionId")
                .description("後臺登入令牌")
                .modelRef(new ModelRef("string"))
                .parameterType("header")
                .required(false)
                .build();

        pars.add(tokenPar.build());
        pars.add(tokenPar1.build());

        return new Docket(DocumentationType.SWAGGER_2)
                .globalOperationParameters(pars)//定義全域性的請求引數
                //.globalResponseMessage( customerResponseMessage())//用來自定義全域性返回錯誤碼
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.lovego.cloud.user"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("使用者中心API")
                .description("使用者中心相關API介面")
                .termsOfServiceUrl("http://localhost:9002")
                .contact("Cory")
                .version("1.0")
                .build();
    }
}