SpringBoot整合Swagger2代码实例
首先遵循SpringBoot的三板斧
第一步添加依赖
io.springfox springfox-swagger2 {version} io.springfox springfox-swaggerui {version}
第二步添加注解
@EnableSwagger2//启动SwaggerUI，在启动类或Swagger配置类上添加该注解
第三步写配置
@Configuration
@EnableSwagger2
publicclassSwaggerConfig{
@Bean
publicDocketapi(){
/*
//可以添加多个header或参数
ParameterBuilderaParameterBuilder=newParameterBuilder();
aParameterBuilder
//参数类型支持header,cookie,body,queryetc
.parameterType("header")
//参数名
.name("user-token")
//默认值
.defaultValue("t122222")
.description("用户登录凭证")
//指定参数值的类型
.modelRef(newModelRef("string"))
//非必需，这里是全局配置
.required(false).build();
ListaParameters=newArrayList<>();
aParameters.add(aParameterBuilder.build());
*/
returnnewDocket(DocumentationType.SWAGGER_2)
//returnnewDocket(DocumentationType.SPRING_WEB)
.apiInfo(apiInfo())
.pathMapping("/")
.select()//选择那些路径和api会生成document
.apis(RequestHandlerSelectors.any())//对所有api进行监控
//不显示错误的接口地址
.paths(Predicates.not(PathSelectors.regex("/error.*")))//错误error路径不监控
.paths(Predicates.not(PathSelectors.regex("/actuator.*")))//错误error路径不监控
.paths(PathSelectors.regex("/.*"))//对根下所有路径进行监控
.paths(PathSelectors.any())//对所有路径进行监控
//自行修改为自己的包路径
//.apis(RequestHandlerSelectors.basePackage("com.happyloves.zc.service.account.api"))
.build()
//.globalOperationParameters(aParameters)
.enable(true);
}
privateApiInfoapiInfo(){
returnnewApiInfoBuilder()
.title("API接口")
.description("API接口文档")
//服务条款网址
//.termsOfServiceUrl("https://www.google.com")
.version("1.0")
//.contact(newContact("啦啦啦","url","email"))
.build();
}
}
扩展：swagger-bootstrap-ui是springfox-swagger的增强UI实现，为Java开发者在使用Swagger的时候，能拥有一份简洁、强大的接口文档
体验项目地址码云：https://gitee.com/xiaoym/swagger-bootstrap-ui
GitHub: https://github.com/xiaoymin/Swagger-Bootstrap-UI
在线体验：http://swagger-bootstrap-ui.xiaominfo.com/doc.html
代码集成示例
SpringBoot在线demo地址：https://gitee.com/xiaoym/swagger-bootstrap-ui-demo
SpringMvc在线demo地址：https://gitee.com/xiaoym/swagger-bootstrap-ui-demo/tree/master/swagger-bootstrap-ui-demo-mvc
添加依赖
com.github.xiaoymin swagger-bootstrap-ui 1.9.6
以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持毛票票。
声明：本文内容来源于网络，版权归原作者所有，内容由互联网用户自发贡献自行上传，本网站不拥有所有权，未作人工编辑处理，也不承担相关法律责任。如果您发现有涉嫌版权的内容，欢迎发送邮件至：czq8825#qq.com（发邮件时，请将#更换为@）进行举报，并提供相关证据，一经查实，本站将立刻删除涉嫌侵权内容。