springboot整合swagger2

客官°小女子只卖身不卖艺 2023-10-09 20:14 2阅读 0赞

## 一、swagger是什么 ##

Swagger 是一个用于生成、描述和调用 RESTful 接口的 Web 服务。必须使用派生注解请求（GetMapping、PostMapping、PutMapping、DeleteMapping）。

通俗的来讲，Swagger 就是将项目中所有（想要暴露的）接口（**接口就是该方法的请求路径**，不是interface）展现在页面上，**并且可以进行接口调用和测试的服务**，（调接口就是给后端发送对应的请求）

1、是一款让你更好的书写API文档的规范且完整框架。

2、提供描述、生产、消费和可视化RESTful Web Service。

3、是由庞大工具集合支撑的形式化规范。这个集合涵盖了从终端用户接口、底层代码库到商业API管理的方方面面

**访问路径：**[http://127.0.0.1:8080/swagger-ui.html\#/][http_127.0.0.1_8080_swagger-ui.html]

## 二、springboot集成swagger ##

### 1、导入依赖 ###

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

### 2、配置类 ###

@Configuration//标为为配置类，相当于spring.xml
    @EnableSwagger2
    public class SwagerrConfiguration {
         private static ApiInfo DEFAULT = null;
         @Bean
        public Docket docket(){
            return new Docket(DocumentationType.SWAGGER_2);
        }
    }

### 3、解决 高版本SpringBoot整合Swagger 启动报错Failed to start bean ‘documentationPluginsBootstrapper‘ 问题 ###

在yaml文件中：

spring:
      #解决 高版本SpringBoot整合Swagger 启动报错Failed to start bean ‘documentationPluginsBootstrapper‘ 问题
      mvc:
        pathmatch:
          matching-strategy: ant_path_matcher

### 4、测试 ###

@RestController
    @RequestMapping("/test")
    public class UserController {
    
        @Autowired
        private UserService userService;
    
        @GetMapping("/user") //使用 @GetMapping这个派生注解，就是为了测试swagger
        //测试swagger访问这个路径http://localhost:8080/swagger-ui.html
        public List<User> test(Integer pageNum,Integer pageSize){
    
            PageInfo<User> pageInfo = userService.selectAllName(pageNum, pageSize);
            List<User> list = pageInfo.getList();
            System.out.println("pageInfo："+pageInfo);
            return list;
        }
    
        @PostMapping("/testPost")
        public String testPost(User user){
            return user.getName();
        }
    
        @RequestMapping("view")
        public String view(){
            return "哈哈哈哈哈哈哈哈哈哈哈哈哈";
        }
    
    }

### 4、访问swagger ###

访问路径：

[http://127.0.0.1:8080/swagger-ui.html\#/][http_127.0.0.1_8080_swagger-ui.html]

![bbd0dba1189143c18ae4bf3d9f61411a.png][]

必须使用 @GetMapping("/user") 使用 @GetMapping这个派生注解请求（GetMapping、PostMapping、PutMapping、DeleteMapping），就是为了测试swagger

![e3d151100ce14d8aaff315411d0c3e62.png][]

点击try it out

![1c3f8fef24ed4c4c8ff01b2fdc9e6f8e.png][]

###  ###

输入实体类对应的属性：![f758e8d9dca9430e843f1989e9c9700c.png][]

点击execute

下面便是响应的数据：![ec331a59e24e454490c92161a1cd6b82.png][]

[http_127.0.0.1_8080_swagger-ui.html]: http://127.0.0.1:8081/swagger-ui.html#/
[bbd0dba1189143c18ae4bf3d9f61411a.png]: https://img-blog.csdnimg.cn/bbd0dba1189143c18ae4bf3d9f61411a.png
[e3d151100ce14d8aaff315411d0c3e62.png]: https://img-blog.csdnimg.cn/e3d151100ce14d8aaff315411d0c3e62.png
[1c3f8fef24ed4c4c8ff01b2fdc9e6f8e.png]: https://img-blog.csdnimg.cn/1c3f8fef24ed4c4c8ff01b2fdc9e6f8e.png
[f758e8d9dca9430e843f1989e9c9700c.png]: https://img-blog.csdnimg.cn/f758e8d9dca9430e843f1989e9c9700c.png
[ec331a59e24e454490c92161a1cd6b82.png]: https://img-blog.csdnimg.cn/ec331a59e24e454490c92161a1cd6b82.png