Springboot集成swagger实现方式
更新时间:2021年08月31日 17:02:19 作者:Shaun_code
这篇文章主要介绍了Springboot集成swagger实现方式,通过简单的示例代码详细描述了实现过程步骤,有需要的朋友可以借鉴参考下,希望可以有所帮助
Swagger 提供了一个全新的维护 API 文档的方式,有4大优点:
- 自动生成文档:只需要少量的注解,Swagger 就可以根据代码自动生成 API 文档,很好的保证了文档的时效性。
- 跨语言性,支持 40 多种语言。
- Swagger UI 呈现出来的是一份可交互式的 API 文档,我们可以直接在文档页面尝试 API 的调用,省去了准备复杂的调用参数的过程。
- 还可以将文档规范导入相关的工具(例如 SoapUI), 这些工具将会为我们自动地创建自动化测试。
如何实现swagger
一: pom文件加入依赖包
<!--swagger-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<!--swagger-ui-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
二:修改配置文件
1.application.properties 加入配置
#表示是否开启 Swagger,一般线上环境是关闭的 spring.swagger2.enabled=true
2.增加一个swagger配置类
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Value(value = "${spring.swagger2.enabled}")
private Boolean swaggerEnabled;
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.enable(swaggerEnabled)
.select()
.apis(RequestHandlerSelectors.basePackage("com.swagger.boot"))//包名代表需要生成接口文档的目录包。
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("接口文档")
.description(" Spring Boot")
.version("1.0")
.build();
}
}
以上就是Springboot集成swagger实现方式的详细内容,更多关于Springboot集成swagger的资料请关注脚本之家其它相关文章!
您可能感兴趣的文章:
相关文章
解决mybatis-plus-boot-starter与mybatis-spring-boot-starter的错误问题
本文主要讲述了在使用MyBatis和MyBatis-Plus时遇到的绑定异常问题,通过排查和总结,作者发现使用MyBatis-Plus Boot Starter可以解决这个问题,文章详细对比了MyBatis-Plus Boot Starter和MyBatis Spring Boot Starter的功能和使用场景2025-01-01
Mybatis plus的自动填充与乐观锁的实例详解(springboot)
这篇文章主要介绍了Mybatis plus的自动填充与乐观锁的实例详解(springboot),本文给大家介绍的非常详细对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下2020-11-11
解析Spring Data JPA的Audit功能之审计数据库变更
Spring Data JPA 提供了Audit审计功能,用来记录创建时间、创建人、修改时间、修改人等,下面来详细讲解下审计数据库变更2021-06-06
SpringBoot使用Maven打包异常-引入外部jar的问题及解决方案
这篇文章主要介绍了SpringBoot使用Maven打包异常-引入外部jar,需要的朋友可以参考下2020-06-06
Spring Security 使用 OncePerRequestFilter
OncePerRequestFilter是一个过滤器,每个请求都会执行一次;一般开发中主要是做检查是否已登录、Token是否过期和授权等操作,而每个操作都是一个过滤器,下面介绍Spring Security 使用 OncePerRequestFilter 过滤器校验登录过期、请求日志等操作方法,感兴趣的朋友一起看看吧2024-06-06
详解Spring框架下向异步线程传递HttpServletRequest参数的坑
这篇文章主要介绍了详解Spring框架下向异步线程传递HttpServletRequest参数的坑,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧2019-03-03


最新评论