gpt4 book ai didi

Springboot集成swagger实现方式

转载 作者:qq735679552 更新时间:2022-09-27 22:32:09 25 4
gpt4 key购买 nike

CFSDN坚持开源创造价值,我们致力于搭建一个资源共享平台,让每一个IT人在这里找到属于你的精彩世界.

这篇CFSDN的博客文章Springboot集成swagger实现方式由作者收集整理,如果你对这篇文章有兴趣,记得点赞哟.

Swagger 提供了一个全新的维护 API 文档的方式,有4大优点:

  • 自动生成文档:只需要少量的注解,Swagger 就可以根据代码自动生成 API 文档,很好的保证了文档的时效性。
  • 跨语言性,支持 40 多种语言。
  • Swagger UI 呈现出来的是一份可交互式的 API 文档,我们可以直接在文档页面尝试 API 的调用,省去了准备复杂的调用参数的过程。
  • 还可以将文档规范导入相关的工具(例如 SoapUI), 这些工具将会为我们自动地创建自动化测试。

如何实现swagger

一: pom文件加入依赖包

?
1
2
3
4
5
6
7
8
9
10
11
12
<!--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 加入配置

?
1
2
#表示是否开启 Swagger,一般线上环境是关闭的
spring.swagger2.enabled= true

2.增加一个swagger配置类

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
@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的资料请关注我其它相关文章! 。

原文链接:https://blog.csdn.net/qq_44807716/article/details/120005709 。

最后此篇关于Springboot集成swagger实现方式的文章就讲到这里了,如果你想了解更多关于Springboot集成swagger实现方式的内容请搜索CFSDN的文章或继续浏览相关文章,希望大家以后支持我的博客! 。

25 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com