SpringBoot集成Swagger

最新推荐文章于 2025-06-16 16:13:01 发布

原创

最新推荐文章于 2025-06-16 16:13:01 发布 · 1.4k 阅读

13 ·

CC 4.0 BY-SA版权

文章标签：

#java #spring #spring boot

SpringBoot集成Swagger

1、Swagger简介

前后端分离

前端：前端控制器、视图层
后端：后端控制器、服务层、数据访问层
前后端通过API进行交互
前后端相对独立且松耦合
前后端甚至可以部署在不同的服务器上

产生一个问题：

前后端集成联调，前端人员和后端人员无法做到，“及时协商，尽早解决”，最终导致问题集中爆发

解决问题

首先制定schema[计划的提纲]，实时更新最新API，降低集成的风险；
前后端分离：
- 前端测试后端接口：postman (早些年)
- 后端提供接口，需要实时更新最新的消息及改动！

Swagger

号称世界上最流行的Api框架
RestFul Api文档在线自动生成工具=> API 文档与API 定义同步更新
直接运行，可以在线测试API接口
支持多种语言：（java，php…）
官网：https://swagger.io/

2、SpringBoot集成Swagger

集成swagger需要 springbox 集成两个Jar包

Springfo-swagger2
swagger-springmvc

集成使用Swagger

步骤：

新建一个SpringBoot项目 web项目

添加Maven依赖

<!--springfox-swagger2-->
<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger2</artifactId>
   <version>2.9.2</version>
</dependency>
<!--springfox-swagger-ui-->
<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger-ui</artifactId>
   <version>2.9.2</version>
</dependency>

编写HelloController,测试确保运行成功！

@RestController
public class HelloController {
     
     

    @RequestMapping(value = "/hello")
    public String hello(){
     
     
        return "hello";
    }

}