如何从openapi swagger中删除“api资源控制器”？

Question

我目前正在使用下面的openapi依赖项。

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

如何从api-resource-controller openapi的屏幕中删除？

​

​

Answer 1

如果您想隐藏某些路径，可以使用springdoc.paths-to-exclude property，文档化的这里。

因此，在您的情况下，您应该使用：

# Paths to exclude
springdoc.paths-to-exclude=/swagger-resources/**

Answer 2

您可以在要隐藏的控制器顶部使用swagger注释中的@Hidden注释。

或者您可以使用属性来筛选端点。显示、按路径或包进行筛选：

# Packages to include
springdoc.packagesToScan=com.package1, com.package2

或

# Paths to include
springdoc.pathsToMatch=/v1, /api/balance/**

Answer 3

您可以从您的swagger配置文件或openapi配置文件中删除@EnableSwagger2，然后这些openapi资源控制器将被真实地删除。