@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();
}
}
如果项目要上生产的时候在配置文件中添加swagger.enable: false即可