spring boot 2整合swagger-ui过程解析
这篇文章主要介绍了springboot2整合swagger-ui过程解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
1.添加mvn依赖
修改pom.xml加入
io.springfox springfox-swagger2 2.5.0 io.springfox springfox-swagger-ui 2.5.0
2.创建配置类
在Application.java同级创建Swagger2的配置类Swagger2
packagecom.tydt.decision; importorg.springframework.context.annotation.Bean; importorg.springframework.context.annotation.Configuration; importspringfox.documentation.builders.ApiInfoBuilder; importspringfox.documentation.builders.PathSelectors; importspringfox.documentation.builders.RequestHandlerSelectors; importspringfox.documentation.service.ApiInfo; importspringfox.documentation.service.Contact; importspringfox.documentation.spi.DocumentationType; importspringfox.documentation.spring.web.plugins.Docket; importspringfox.documentation.swagger2.annotations.EnableSwagger2; @Configuration @EnableSwagger2 publicclassSwagger2{ @Bean publicDocketcreateRestApi(){ returnnewDocket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("com.tydt.decision.controller")) .paths(PathSelectors.any()).build(); } privateApiInfoapiInfo(){ returnnewApiInfoBuilder().title("DecisionManageSwaggerRESTfulAPIs") .description("DecisionAPI") .termsOfServiceUrl("http://swagger.io/") .contact(newContact("Beibei","127.0.0.1","XXXXXXX@qq.com")) .version("1.0") .build(); } }
注:
如果出现下面情况
引入需要的包
但是启动时又出现Errorcreatingbeanwithname'apiDocumentationScanner'definedinURL
这是由于swagger依赖google的guava,需要添加依赖,而当前项目的guava版本与之不匹配,修改为
com.google.guava guava 15.0
http://localhost:8090/swagger-ui.html页面没显示
这是因为SpringBoot自动配置本身不会自动把/swagger-ui.html这个路径映射到对应的目录META-INF/resources/下面。加上这个映射即可
@Configuration publicclassWebMvcConfigimplementsWebMvcConfigurer{ …… publicvoidaddResourceHandlers(ResourceHandlerRegistryregistry){ registry.addResourceHandler("swagger-ui.html") .addResourceLocations("classpath:/META-INF/resources/"); registry.addResourceHandler("/webjars/**") .addResourceLocations("classpath:/META-INF/resources/webjars/"); } }
解决了上面出现的问题,访问http://localhost:8090/swagger-ui.html就能看到下面的页面了
说明:
(1)通过@Configuration注解,让Spring来加载该类配置
(2)再通过@EnableSwagger2注解来启用Swagger2
(3)通过createRestApi函数创建Docket的Bean之后,apiInfo()用来创建该Api的基本信息
(4)select()函数返回一个ApiSelectorBuilder实例用来控制哪些接口暴露给Swagger来展现
(5)指定扫描的包路径来定义,会扫描该包下所有Controller定义的API,并产生文档内容,除了用@ApiIgnore指定的
(6)通过@ApiOperation注解来给API增加说明
(7)通过@ApiImplicitParams
(8)@ApiImplicitParam注解来给参数增加说明
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持毛票票。
声明:本文内容来源于网络,版权归原作者所有,内容由互联网用户自发贡献自行上传,本网站不拥有所有权,未作人工编辑处理,也不承担相关法律责任。如果您发现有涉嫌版权的内容,欢迎发送邮件至:czq8825#qq.com(发邮件时,请将#更换为@)进行举报,并提供相关证据,一经查实,本站将立刻删除涉嫌侵权内容。