SpringBoot：集成Swagger 上

最新推荐文章于 2024-07-04 14:45:25 发布

ahyo

最新推荐文章于 2024-07-04 14:45:25 发布

阅读量96

点赞数

本文链接：https://blog.csdn.net/yooppa/article/details/126514287

版权

细节专栏收录该内容

75 篇文章 1 订阅

订阅专栏

本文介绍了Swagger作为流行的API框架，用于解决前后端集成时的问题。通过在SpringBoot项目中集成Swagger，可以实现API文档的自动生成和在线测试。文章详细阐述了集成步骤，包括添加依赖、配置Swagger、编写控制器以及访问测试。最后，展示了如何通过Docket配置文档信息，并提供了访问Swagger UI的URL。

摘要由CSDN通过智能技术生成

Swagger简介（虽然之前讲到过不妨碍作为再一次回顾）：
前后端分离需要涉及到的

前端：前端控制层、视图层
后端：后端控制层、服务层、数据访问层

前后端通过API进行交互，前后端相对独立且松耦合

产生的问题：前后端集成，前端或者后端无法做到“及时协商，尽早解决”，最终导致问题集中爆发

解决方案：首先定义schema [ 计划的提纲 ]，并实时跟踪最新的API，降低集成风险

Swagger——号称世界上最流行的API框架
Restful Api 文档在线自动生成器 => API 文档与API 定义同步更新
直接运行，在线测试API，支持多种语言

SpringBoot集成Swagger
SpringBoot集成Swagger => springfox，两个jar包

Springfox-swagger2

swagger-springmvc

使用Swagger

要求：jdk 1.8 + 否则swagger2无法运行

步骤：

1、新建一个SpringBoot-web项目

2、添加Maven依赖

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger2</artifactId>
   <version>2.9.2</version>
</dependency>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger-ui</artifactId>
   <version>2.9.2</version>
</dependency>

3、编写HelloController，测试确保运行成功！

4、要使用Swagger，需要编写一个配置类-SwaggerConfig来配置 Swagger

@Configuration //配置类
@EnableSwagger2// 开启Swagger2的自动配置
public class SwaggerConfig {
}
5、访问测试：http://localhost:8080/swagger-ui.html ，可以看到swagger的界面；

配置Swagger
1、Swagger实例Bean是Docket，所以通过配置Docket实例来配置Swaggger。

@Bean //配置docket以配置Swagger具体参数
public Docket docket() {
return new Docket(DocumentationType.SWAGGER_2);
}
2、可以通过apiInfo()属性配置文档信息

//配置文档信息
private ApiInfo apiInfo() {
Contact contact = new Contact(“联系人名字”, “http://xxx.xxx.com/联系人访问链接”, “联系人邮箱”);
return new ApiInfo(
“Swagger学习”, // 标题
“学习演示如何配置Swagger”, // 描述
“v1.0”, // 版本
“http://terms.service.url/组织链接”, // 组织链接
contact, // 联系人信息
“Apach 2.0 许可”, // 许可
“许可链接”, // 许可连接
new ArrayList<>()// 扩展
);
}
3、Docket 实例关联上 apiInfo()

@Bean
public Docket docket() {
return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());
}
4、重启项目，访问测试 http://localhost:8080/swagger-ui.html 看下效果；