带有 Boot 3 的 Springdoc，没有显式的 OpenAPI bean 声明

Question

我在为我的应用程序创建 Swagger/Open API 端点时遇到问题。以前有一个应用程序会自动创建这样的端点。我想避免显式声明 OpenAPI bean。我的理解是我只需要

springdic-openapi-ui

依赖项和 swagger UI 端点的属性，以防我想覆盖它（默认为

/swagger-ui.html

）。然而，在我最近的应用程序

/swagger-ui.html

中，情况并非如此。

在下面的 MRE 中，

GET /api/hello

按预期工作。

GET /swagger-ui.html

返回 404，这表明由于某种原因该端点不是由 Swagger 创建的。

可能是版本兼容性问题：我现在使用 Boot 3，我之前提到的应用程序使用 Boot 2。

这是 MRE：

package com.example.openapi_demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class OpenapiDemoApplication {

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

}

server.port=8080

<?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>3.3.5</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>openapi-demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>openapi-demo</name>
    <properties>
        <java.version>17</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <dependency>
            <groupId>org.springdoc</groupId>
            <artifactId>springdoc-openapi-ui</artifactId>
            <version>1.8.0</version>
        </dependency>
    </dependencies>

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

</project>

package com.example.openapi_demo;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/api")
public class DemoController {
    @GetMapping("/hello")
    public String getHello() {
        return "hello";
    }
}

Answer 1

        <dependency>
            <groupId>org.springdoc</groupId>
            <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
            <version>2.6.0</version>
        </dependency>

用这个。删除您可能添加的任何其他配置。 在 ${baseUrl}/swagger-ui/index.html 上访问它