如何在 Swagger API 文档中排除 lib
How to exclude lib in Swagger API documentation
我在 jaxrs 应用程序中使用了 keycloak-admin-client,并使用 swagger 生成了 API 文档。 Swagger为keycloak-admin-client中的所有方法生成文档。如何从 swagger 文档中排除这个库?
依赖关系:
<dependency>
<groupId>org.keycloak</groupId>
<artifactId>keycloak-admin-client</artifactId>
<version>7.0.0</version>
</dependency>
<dependency>
<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-jaxrs2</artifactId>
<version>2.1.0</version>
</dependency>
<dependency>
<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-jaxrs2-servlet-initializer</artifactId>
<version>2.1.0</version>
</dependency>
通过此解决方案仅分配我的包进行扫描
@ApplicationPath("/api")
public class ApplicationInitializer 扩展应用程序 {
public ApplicationInitializer(@Context ServletConfig servletConfig) {
super();
OpenAPI oas = new OpenAPI();
try {
Set<String> resource = new HashSet<>();
resource.add("my.company.api.path");
SwaggerConfiguration oasConfig = new SwaggerConfiguration()
.openAPI(oas)
.prettyPrint(true)
.resourcePackages(resource);
OpenApiContext oac = new JaxrsOpenApiContextBuilder()
.servletConfig(servletConfig)
.application(this)
.openApiConfiguration(oasConfig)
.buildContext(true);
oac.read();
} catch (OpenApiConfigurationException e) {
throw new RuntimeException(e.getMessage(), e);
}
}
}
我在 jaxrs 应用程序中使用了 keycloak-admin-client,并使用 swagger 生成了 API 文档。 Swagger为keycloak-admin-client中的所有方法生成文档。如何从 swagger 文档中排除这个库?
依赖关系:
<dependency>
<groupId>org.keycloak</groupId>
<artifactId>keycloak-admin-client</artifactId>
<version>7.0.0</version>
</dependency>
<dependency>
<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-jaxrs2</artifactId>
<version>2.1.0</version>
</dependency>
<dependency>
<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-jaxrs2-servlet-initializer</artifactId>
<version>2.1.0</version>
</dependency>
通过此解决方案仅分配我的包进行扫描
@ApplicationPath("/api")
public class ApplicationInitializer 扩展应用程序 {
public ApplicationInitializer(@Context ServletConfig servletConfig) {
super();
OpenAPI oas = new OpenAPI();
try {
Set<String> resource = new HashSet<>();
resource.add("my.company.api.path");
SwaggerConfiguration oasConfig = new SwaggerConfiguration()
.openAPI(oas)
.prettyPrint(true)
.resourcePackages(resource);
OpenApiContext oac = new JaxrsOpenApiContextBuilder()
.servletConfig(servletConfig)
.application(this)
.openApiConfiguration(oasConfig)
.buildContext(true);
oac.read();
} catch (OpenApiConfigurationException e) {
throw new RuntimeException(e.getMessage(), e);
}
}
}