如何在Springdoc-openapi-ui的Swagger UI中启用BasicErrorController？

springdoc-openapi默认会排除Spring自带的BasicErrorController，所以迁移后它不会自动出现在Swagger UI中，你可以通过以下配置让它被扫描并展示：

方法一：通过配置文件指定扫描范围 #

在application.properties中添加：

# 扫描BasicErrorController所在的包
springdoc.packages-to-scan=org.springframework.boot.autoconfigure.web.servlet.error
# 匹配/error路径
springdoc.paths-to-match=/error

或者使用application.yml格式：

springdoc:
  packages-to-scan: org.springframework.boot.autoconfigure.web.servlet.error
  paths-to-match: /error

方法二：通过Java配置类手动注册 #

创建一个OpenAPI配置类，专门为错误控制器创建分组并指定扫描规则：

import org.springdoc.core.GroupedOpenApi;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class OpenApiConfig {

    @Bean
    public GroupedOpenApi errorApi() {
        return GroupedOpenApi.builder()
                .group("error-controller")
                .addPackageToScan("org.springframework.boot.autoconfigure.web.servlet.error")
                .pathsToMatch("/error")
                .build();
    }
}

配置完成后重启服务，就能在Swagger UI中看到BasicErrorController的/error端点了。

内容的提问来源于stack exchange，提问作者Harjinder Pal Singh