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

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

Swagger版本：3.0.0

SpringBoot版本：2.5.6

目录

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

​​二、引入依赖pom​​

​​三、SwaggerConfig配置类​​

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

​​五、开启Swagger注解​​

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

一、初始化SpringBoot项目 

二、引入依赖pom

<!--整合Swagger3.0 -->
<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

 六、访问在线接口文档

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