SpringBoot实战教程（1）| 整合Swagger3.0.0

我不是女神ヾ 2023-10-02 14:51 34阅读 0赞

> 本文教你如何在SpringBoot中整合Swagger,快速实现在线接口文档。
> 
> Swagger版本：3.0.0
> 
> SpringBoot版本：2.5.6

**目录**

一、初始化SpringBoot项目

二、引入依赖pom

三、SwaggerConfig配置类

四、编写测试接口

五、开启Swagger注解

六、访问在线接口文档

--------------------

## 一、初始化SpringBoot项目 ##

![watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAUm9jLXhi_size_20_color_FFFFFF_t_70_g_se_x_16][]

## 二、引入依赖pom ##

<dependency> 
      <groupId>io.springfox</groupId>  
      <artifactId>springfox-boot-starter</artifactId>  
      <version>3.0.0</version> 
    </dependency>

## 三、SwaggerConfig配置类 ##

package com.csdn.config;
    
    import io.swagger.annotations.ApiOperation;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import springfox.documentation.builders.ApiInfoBuilder;
    import springfox.documentation.builders.PathSelectors;
    import springfox.documentation.builders.RequestHandlerSelectors;
    import springfox.documentation.service.ApiInfo;
    import springfox.documentation.service.Contact;
    import springfox.documentation.spi.DocumentationType;
    import springfox.documentation.spring.web.plugins.Docket;
    
    @Configuration
    public class SwaggerConfig {
    
        @Bean
        public Docket createRestApi() {
            return new Docket(DocumentationType.OAS_30)
                    // 是否启用Swagger
                    .enable(true)
                    // 用来创建该API的基本信息，展示在文档的页面中（自定义展示的信息）
                    .apiInfo(apiInfo())
                    // 设置哪些接口暴露给Swagger展示
                    .select()
                    // 扫描所有有注解的api，用这种方式更灵活
                    .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                    // 扫描指定包中的swagger注解
                    //.apis(RequestHandlerSelectors.basePackage("com.csdn.controller"))
                    // 扫描所有 .apis(RequestHandlerSelectors.any())
                    .paths(PathSelectors.any())
                    .build();
        }
    
        /**
         * 添加摘要信息
         */
        private ApiInfo apiInfo() {
            // 用ApiInfoBuilder进行定制
            return new ApiInfoBuilder()
                    // 设置标题
                    .title("在线接口文档")
                    // 描述
                    .description("API在线接口文档管理")
                    // 作者信息
                    .contact(new Contact("admin", null, null))
                    // 版本
                    .version("1.0.0")
                    .build();
        }
    }

## 四、编写测试接口 ##

package com.csdn.controller;
    
    import io.swagger.annotations.Api;
    import io.swagger.annotations.ApiOperation;
    import org.springframework.web.bind.annotation.*;
    
    @Api(tags = "api接口测试")
    @RestController
    @RequestMapping("/api")
    public class ApiController {
        @ApiOperation(value = "查询所有用户")
        @GetMapping("/users")
        public String list() {
            return "1";
        }
    
        @ApiOperation(value = "添加用户")
        @PostMapping("/users")
        public String add() {
            return "2";
        }
    
        @ApiOperation(value = "编辑用户")
        @PutMapping("/users")
        public String update() {
            return "3";
        }
    
        @ApiOperation(value = "删除用户")
        @DeleteMapping("/users")
        public String delete() {
            return "4";
        }
    }

## 五、开启Swagger注解 ##

@EnableOpenApi

![watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAUm9jLXhi_size_20_color_FFFFFF_t_70_g_se_x_16 1][]

## 六、访问在线接口文档 ##

http://localhost:8080/swagger-ui/index.html

![watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAUm9jLXhi_size_20_color_FFFFFF_t_70_g_se_x_16 2][]

[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAUm9jLXhi_size_20_color_FFFFFF_t_70_g_se_x_16]: https://img-blog.csdnimg.cn/82860061a5094a4b9906edf35d29b673.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBAUm9jLXhi,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAUm9jLXhi_size_20_color_FFFFFF_t_70_g_se_x_16 1]: https://img-blog.csdnimg.cn/58532bc56dcf4faf9db0bd29aeeeaeb9.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBAUm9jLXhi,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAUm9jLXhi_size_20_color_FFFFFF_t_70_g_se_x_16 2]: https://img-blog.csdnimg.cn/96c77e9eb57642e39778b63aa85da4d9.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBAUm9jLXhi,size_20,color_FFFFFF,t_70,g_se,x_16