SpringBoot集成Swagger3.0（入门）01

news2025/1/11 7:49:49

创建SpringBoot项目

创建完成后再pom文件中导入swagger3.0依赖，具体的pom文件内容如下：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.6.5</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.xct</groupId>
    <artifactId>swagger_1</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>swagger_1</name>
    <description>swagger_1</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--swagger3.0-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

注意：

spring boot版本 swagger版本
2.5.6 2.9.2
2.6.5 3.0.0

这里我们用的是Swagger3.0，所以需要将SpringBoot版本降到2.6.5。

并且需要在yml文件中添加如下配置
server:
  port: 8082 # 可自定义
spring:
  mvc:
    pathmatch:
      matching-strategy: ant_path_matcher

spring boot版本	swagger版本
2.5.6	2.9.2
2.6.5	3.0.0

在启动类上添加开启Swagger的注解。

package com.xct.swagger_1;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import springfox.documentation.oas.annotations.EnableOpenApi;

@SpringBootApplication
@EnableOpenApi
public class Swagger1Application {

    public static void main(String[] args) {
        SpringApplication.run(Swagger1Application.class, args);
    }

}

新建一个controller控制器测试接口。

package com.xct.swagger_1.controller;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author xct
 * @date 2023年03月01日 16:08
 */
@Api("接口测试")
@RestController
public class TestController {

    @ApiOperation("测试功能1")
    @GetMapping("/hello")
    public String test(){
        return "HelloYc";
    }
}