Springdoc-OpenAPI v1.6.14 官网（中文版）_springdoc官网

Springdoc-OpenAPI v1.6.14 官网（中文版）

带有 spring-boot 的 OpenAPI 3 库 作者：Badr NASS LAHSEN
springdoc-openapi在开放集体上。如果您这个项目❤️考虑成为赞助商。
本项目由

1. 简介

springdoc-openapi Java 库有助于使用 Spring 引导项目自动生成 API 文档。 通过在运行时检查应用程序来根据 Spring 配置、类结构和各种注释推断 API 语义。springdoc-openapi

自动生成 JSON/YAML 和 HTML 格式 API 中的文档。 本文档可以通过使用 swagger-api 注释的评论来完成。

此库支持：

• OpenAPI 3
• Spring-boot (v1, v2 and v3)
• JSR-303, specifically for @NotNull, @Min, @Max, and @Size.
• Swagger-ui
• OAuth 2
• GraalVM native images

以下视频介绍了库：

这是一个基于社区的项目，不是由Spring框架贡献者（Pivotal）维护的。

2. 入门

对于 spring-boot 和 swagger-ui 之间的集成，请将库添加到项目依赖项列表中（无需其他配置）

<dependency>
      <groupId>org.springdoc</groupId>
      <artifactId>springdoc-openapi-ui</artifactId>
      <version>1.6.14</version>
   </dependency>
1
2
3
4
5

这将自动将 swagger-ui 部署到 spring-boot 应用程序：

• 文档将以HTML格式提供，使用官方的swagger-ui jar
• 然后，Swagger UI页面将在以下网址上提供，OpenAPI描述将在以下json格式的URL上提供：http://server:port/context-path/swagger-ui.html
  http://server:port/context-path/v3/api-docs

o 服务器：服务器名称或 IP
o 端口：服务器端口
o 上下文路径：应用程序的上下文路径

• 文档也可以以yaml格式提供，路径如下：/v3/api-docs.yaml

# swagger-ui custom path
springdoc.swagger-ui.path=/swagger-ui.html
1
2

3. Springdoc-openapi 模块

3.1. 概述

3.2. Spring WebMvc 支持

• 文档将在以下 json 格式的 url 中提供：http://server:port/context-path/v3/api-docs
  o 服务器：服务器名称或 IP
  o 端口：服务器端口
  o 上下文路径：应用程序的上下文路径
• 文档也将以yaml格式提供，路径如下：/v3/api-docs.yaml
• 将库添加到项目依赖项列表中。（无需其他配置）

 <dependency>
      <groupId>org.springdoc</groupId>
      <artifactId>springdoc-openapi-webmvc-core</artifactId>
      <version>1.6.14</version>
   </dependency>
1
2
3
4
5

# /api-docs endpoint custom path
springdoc.api-docs.path=/api-docs
1
2

3.3. Spring WebFlux 支持

• 文档也可以以yaml格式提供，路径如下：/v3/api-docs.yaml
• 将库添加到项目依赖项列表中（无需其他配置）

   <dependency>
      <groupId>org.springdoc</groupId>
      <artifactId>springdoc-openapi-webflux-ui</artifactId>
      <version>1.6.14</version>
   </dependency>
1
2
3
4
5

3.4. Spring Hateoas 支持

对Spring Hateoas的支持可以使用依赖项springdoc-openapi-hateoas获得。 使用 Spring Hateoas 的项目应该将此依赖项与 springdoc-openapi-ui 依赖项相结合。 这种依赖关系支持Spring Hateoas格式。

   <dependency>
      <groupId>org.springdoc</groupId>
      <artifactId>springdoc-openapi-hateoas</artifactId>
      <version>1.6.14</version>
   </dependency>

1
2
3
4
5
6

3.5. Spring Data Rest 支持

使用的项目可以结合依赖项添加以下依赖项。 此依赖项支持以下类型： 和批注。spring-data-rest、springdoc-openapi-ui、spring-boot-starter-data-rest、@RepositoryRestResource、QuerydslPredicate

      <dependency>
      <groupId>org.springdoc</groupId>
      <artifactId>springdoc-openapi-data-rest</artifactId>
      <version>1.6.14</version>
   </dependency>

1
2
3
4
5
6

3.6. Spring Security 支持

对于使用 spring-security 的项目，您应该添加以下依赖项，并结合 springdoc-openapi-ui 依赖项： 此依赖项有助于忽略@AuthenticationPrincipal以防其在 REST 控制器上使用。

   <dependency>
      <groupId>org.springdoc</groupId>
      <artifactId>springdoc-openapi-security</artifactId>
      <version>1.6.14</version>
   </dependency>

1
2
3
4
5
6

3.7. Spring Native support

springdoc-openapi，支持开箱即用的 GraalVM 本机映像。 如果应用程序使用 spring-native，则应将以下依赖项与 （ 或 ） 依赖项结合使用： - 此依赖项有助于对 springdoc-openapi 的本机支持（仅在 之后可用）。springdoc-openapi-uispringdoc-openapi-webflux-uiv1.5.13

   <dependency>
      <groupId>org.springdoc</groupId>
      <artifactId>springdoc-openapi-native</artifactId>
      <version>1.6.14</version>
   </dependency>
1
2
3
4
5

这是兼容性矩阵，其中显示了经过测试/验证的版本：springdoc-openapi

3.8. Actuator 支持

为了显示端点，只需添加以下属性：spring-boot-actuator

springdoc.show-actuator=true
1

从版本1.5.1开始，可以在执行器端口上公开 swagger-ui 和 openapi 端点。

若要公开 swagger-ui，应在管理端口上设置

springdoc.use-management-port=true

# This property enables the openapi and swagger-ui endpoints to be exposed beneath the actuator base path.
management.endpoints.web.exposure.include=openapi, swagger-ui

该属性允许openapi和swagger-ui端点暴露在执行器基本路径下。
management.endpoints.web.exposure。包括= openapi swagger-ui
1
2
3
4
5
6
7

启用后，您还应该能够在以下位置看到 springdoc-openapi 端点：（主机和端口取决于您的设置） -http://serverName:managementPort/actuator

例如，如果您有以下设置：
将有两个端点可用：

1. 保存 OpenAPI 定义的 REST API：
   http://serverName:managementPort/actuator/openapi

2. 一个终结点，用于路由到 swagger-ui：
   http://serverName:managementPort/actuator/swagger-ui

management.server.port=9090
1

对于这个例子，你还应该能够看到springdoc-openapi端点：

• http://serverName:9090/actuator
• http://serverName:9090/actuator/swagger-ui
• http://serverName:9090/actuator/openapi

所有路径属性在 时都不适用。springdoc-openapispringdoc.use-management-port=true

此外，还可以将此属性与现有属性结合使用，以在 swagger-ui 中显示执行器终结点。

springdoc.show-actuator=true
1

启用后： - 默认情况下，将添加执行器端点的专用组。 - 如果没有为应用程序定义组，则将添加一个默认组。

然后，可以通过执行器端口访问 swagger-upi：

• http://serverName:managementPort/actuator/swagger-ui
• 如果管理端口与应用程序端口不同且未定义但设置为 true：springdoc.use-management-portspringdoc.show-actuator
• 然后，可以通过应用程序端口访问 swagger-ui。例如：http://serverName:applicationPort/swagger-ui.html
• 默认情况下，将添加执行器端点的专用组。
• 如果未为应用程序定义任何组，则将添加一个默认组。

3.9. Spring Cloud Function Web 支持

spring-cloud-function-web自动将 Java 函数公开为 REST 端点。 *从v1.6.3版本开始，增加了对功能端点的支持。

• 这些启动器将显示端点的 OpenAPI 描述。spring-cloud-function-web
  1.如果您使用的是 ，只需添加依赖项即可。spring-webspringdoc-openapi-ui
  2.如果您使用的是 ，只需添加依赖项即可。spring-webfluxspringdoc-openapi-webflux-ui

输出的自定义可以通过以下注释或带有注释以编程方式实现：和。 对于注释用法，您有： * ：如果自定义与单个 REST API 相关，则可以单独使用。 使用 时，不强制要求填充路径OpenApiCustomize 、 @RouterOperations 、 @RouterOperation 、 @RouterOperation 、 @RouterOperation

• @RouterOperation，包含批注。 如果声明了属性 beanMethod，则还可以将注释放在 Bean 方法级别。@Operation@Operation
  

@Bean
@RouterOperation(operation = @Operation(description = "Say hello", operationId = "hello", tags = "persons",
        responses = @ApiResponse(responseCode = "200", content = @Content(schema = @Schema(implementation = PersonDTO.class)))))
public Supplier<PersonDTO> helloSupplier() {
    return () -> new PersonDTO();
}
1
2
3
4
5
6

一些代码示例可在演示的GITHUB上找到：
使用Spring Cloud Function Web 的示例应用程序

3.10 Kotlin 支持

对于使用 Kotlin 的项目，您应该添加以下依赖项。 这种依赖关系改进了对 Kotlin 类型的支持：

   <dependency>
      <groupId>org.springdoc</groupId>
      <artifactId>springdoc-openapi-kotlin</artifactId>
      <version>1.6.14</version>
   </dependency>

1
2
3
4
5
6

• 如果您使用的是 spring-web，则应将模块与 .springdoc-openapi-kotlinspringdoc-openapi-ui
• 如果您使用的是 spring-webflux，则应将模块与 .springdoc-openapi-kotlinspringdoc-openapi-webflux-ui

3.11 Groovy 支持

对于使用 Groovy 的项目，您应该添加以下依赖项，并结合 springdoc-openapi-ui 依赖项： 这种依赖关系改进了对 Kotlin 类型的支持：

   <dependency>
      <groupId>org.springdoc</groupId>
      <artifactId>springdoc-openapi-groovy</artifactId>
      <version>1.6.14</version>
   </dependency>

1
2
3
4
5
6

3.12. Javadoc 支持

对于想要启用 javadoc 支持的项目，应将以下依赖项与依赖项结合使用：springdoc-openapi-ui

   <dependency>
      <groupId>org.springdoc</groupId>
      <artifactId>springdoc-openapi-javadoc</artifactId>
      <version>1.6.14</version>
   </dependency>
1
2
3
4
5

这种依赖关系改进了对javadoc标签和注释的支持：

• 方法的 javadoc 注释：解析为描述@Operation
• @return ：解析为响应描述@Operation
• 属性的 javadoc 注释：解析为此字段的“@Schema”描述。
  此依赖项基于 therapi-runtime-javadoc 库

build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <annotationProcessorPaths>
                        <path>
                            <groupId>com.github.therapi</groupId>
                            <artifactId>therapi-runtime-javadoc-scribe</artifactId>
                            <version>0.15.0</version>
                        </path>
                    </annotationProcessorPaths>
                </configuration>
            </plugin>
        </plugins>
    </build>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

Tip：如果同时存在swagger-annotation描述和javadoc注释，将使用swagger注释描述的值

4.Springdoc-openapi特性

4.1. 添加 API 信息和安全文档

该库使用 spring-boot 应用程序自动配置的软件包来扫描 spring bean 中的以下注释：OpenAPIDefinition 和 Info。 这些注释声明了 API 信息：标题、版本、许可证、安全性、服务器、标记、安全性和外部文档。 为了更好地生成文档，请在 Spring 管理的 Bean 中声明@OpenAPIDefinition和@SecurityScheme注释。

4.2. 使用 @ControllerAdvice 处理 REST 的错误

要自动生成文档，请确保所有方法都使用注释声明 HTTP 代码响应：@ResponseStatus

4.3. 禁用端点springdoc-openapi

要禁用终结点（默认情况下为 /v3/api-docs），请使用以下属性：springdoc-openapi

# Disabling the /v3/api-docs endpoint
springdoc.api-docs.enabled=false
1
2

4.4. 禁用swagger用户界面

要禁用 swagger-ui，请使用以下属性：

# Disabling the swagger-ui
springdoc.swagger-ui.enabled=false
1
2

4.5 Swagger-ui 的 用户界面配置

该库支持 swagger-ui 官方属性：

• https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/

您需要将 swagger-ui 属性声明为 spring-boot 属性。 所有这些属性都应使用以下前缀声明：springdoc.swagger-ui

4.6 选择要包含在文档中的其余控制器

此外，要从 swagger-annotation 中@Hidden注释，可以使用包或路径配置来限制生成的 OpenAPI 描述。
对于要包含的包列表，请使用以下属性：

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

1
2
3

对于要包含的路径列表，请使用以下属性：

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

4.7. 带有功能端点的 Spring-webflux/WebMvc.fn

从 v1.5.0 版本开始，由于 spring 框架中的此增强功能，引入了功能性 DSL：#25938

它是注释的替代功能 API。@RouterOperations

这是一个示例DSL，用于生成webflux / WebMvc.fn REST端点的OpenAPI描述：

@Bean
RouterFunction<?> routes() {
    return route().GET("/foo", HANDLER_FUNCTION, ops -> ops
            .operationId("hello")
            .parameter(parameterBuilder().name("key1").description("My key1 description"))
            .parameter(parameterBuilder().name("key2").description("My key2 description"))
            .response(responseBuilder().responseCode("200").description("This is normal response description"))
            .response(responseBuilder().responseCode("404").description("This is another response description"))
    ).build();
}
1
2
3
4
5
6
7
8
9
10

以下是一些示例代码的链接：

• 你好路由器
• 行情路由器
• 图书路由器
• 员工路由器
• 位置路由器
  以及使用功能终结点 DSL 的演示代码：
• 使用函数式 DSL 的 webflux 应用程序示例

从v1.3.8版本开始，增加了对功能端点的支持。 为此添加了两个主要注释：和 。@RouterOperations@RouterOperation

只有带有 和 的 REST API 才能显示在 swagger-ui 上。@RouterOperations @RouterOperation

• @RouterOperation：如果路由器 Bean 包含一个与 REST API 相关的路由，则可以单独使用。 使用@RouterOperation时，不强制填充路径
• @RouterOperation，可以直接引用 Spring Bean（beanClass 属性）和底层方法（beanMethod 属性）：Springdoc-openapi，然后将检查此方法和此方法级别的 swagger 注释。

@Bean
@RouterOperation(beanClass = EmployeeService.class, beanMethod = "findAllEmployees")
RouterFunction<ServerResponse> getAllEmployeesRoute() {
   return route(GET("/employees").and(accept(MediaType.APPLICATION_JSON)),
         req -> ok().body(
               employeeService().findAllEmployees(), Employee.class));
}
1
2
3
4
5
6
7

• @RouterOperation，包含批注。 如果声明了属性 beanMethod，则还可以将注释放在 Bean
  方法级别。@Operation @Operation
  

@Bean
@RouterOperation(operation = @Operation(operationId = "findEmployeeById", summary = "Find purchase order by ID", tags = { "MyEmployee" },
      parameters = { @Parameter(in = ParameterIn.PATH, name = "id", description = "Employee Id") },
      responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = @Content(schema = @Schema(implementation = Employee.class))),
            @ApiResponse(responseCode = "400", description = "Invalid Employee ID supplied"),
            @ApiResponse(responseCode = "404", description = "Employee not found") }))
RouterFunction<ServerResponse> getEmployeeByIdRoute() {
   return route(GET("/employees/{id}"),
         req -> ok().body(
               employeeRepository().findEmployeeById(req.pathVariable("id")), Employee.class));
}
1
2
3
4
5
6
7
8
9
10
11

• @RouterOperations：如果路由器 Bean 包含多个路由，则应使用此注释。 使用路由器操作时，必须填写路径属性。
• A ，包含许多 。@RouterOperations@RouterOperation

@RouterOperations({ @RouterOperation(path = "/getAllPersons", beanClass = PersonService.class, beanMethod = "getAll"),
      @RouterOperation(path = "/getPerson/{id}", beanClass = PersonService.class, beanMethod = "getById"),
      @RouterOperation(path = "/createPerson", beanClass = PersonService.class, beanMethod = "save"),
      @RouterOperation(path = "/deletePerson/{id}", beanClass = PersonService.class, beanMethod = "delete") })
@Bean
public RouterFunction<ServerResponse> personRoute(PersonHandler handler) {
   return RouterFunctions
         .route(GET("/getAllPersons").and(accept(MediaType.APPLICATION_JSON)), handler::findAll)
         .andRoute(GET("/getPerson/{id}").and(accept(MediaType.APPLICATION_STREAM_JSON)), handler::findById)
         .andRoute(POST("/createPerson").and(accept(MediaType.APPLICATION_JSON)), handler::save)
         .andRoute(DELETE("/deletePerson/{id}").and(accept(MediaType.APPLICATION_JSON)), handler::delete);
}
1
2
3
4
5
6
7
8
9
10
11
12

所有使用@RouterOperation填写的文档，都可以由路由器功能数据来完成。 为此，字段必须帮助唯一标识相关路由。 使用以下条件扫描与注记相关的唯一路径：@RouterOperation 、springdoc-openpi @RouterOperation

• 按路径
• 按路径和请求方法
• 按路径和生产
• 按路径和消耗
• 通过路径和请求方法并生成
• 按路径和请求方法并消耗
• 按路径和生产和消费
• 按路径和请求方法生成和使用

一些代码示例可在演示的GITHUB上找到：

• 具有功能终结点文档的示例应用程序

和一些项目测试：（从app69到app75）

• 包含功能终结点文档的示例代码

4.8. 与WildFly集成

对于 WildFly 用户，您需要添加以下依赖项才能使 swagger-ui 正常工作：

   <dependency>
     <groupId>org.webjars</groupId>
     <artifactId>webjars-locator-jboss-vfs</artifactId>
     <version>0.1.0</version>
   </dependency>

1
2
3
4
5
6

springdoc-openapi依赖于使用标准文件位置的标准 Spring 配置属性（YML 或属性）。

5. Springdoc-openapi 属性

springdoc-openapi依赖于使用标准文件位置的标准 Spring 配置属性（YML 或属性）。

5.1. Springdoc-OpenAPI 核心属性

5.2. swagger-ui 属性

• 上提供了对 swagger-ui 属性的支持。请参阅官方文档。springdoc-openapi
• 您可以在文档中使用与 Spring 引导属性相同的 swagger-ui 属性。
  

6. Springdoc-openapi 插件

6.1. Maven插件

其目的是在构建时生成json和yaml OpenAPI描述。 该插件在集成测试阶段工作，并生成 OpenAPI 描述。 该插件与 spring-boot-maven 插件结合使用。springdoc-openapi-maven-plugin

您可以在集成测试阶段使用 maven 命令对其进行测试：

mvn verify
1

为了使用此功能，您需要在pom的插件部分添加插件声明.xml：

<plugin>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-maven-plugin</artifactId>
    <version>${spring-boot-maven-plugin.version}</version>
    <configuration>
        <jvmArguments>-Dspring.application.admin.enabled=true</jvmArguments>
    </configuration>
    <executions>
        <execution>
            <goals>
                <goal>start</goal>
                <goal>stop</goal>
            </goals>
        </execution>
    </executions>
</plugin>
<plugin>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-maven-plugin</artifactId>
    <version>1.4</version>
    <executions>
        <execution>
            <id>integration-test</id>
            <goals>
                <goal>generate</goal>
            </goals>
        </execution>
    </executions>
</plugin>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

有关 springdoc-openapi-maven-plugin 的更多自定义设置，您可以查阅插件文档：
https://github.com/springdoc/springdoc-openapi-maven-plugin

6.2. Gradle 插件

此插件允许您从 Gradle 构建为 Spring Boot 应用程序生成 OpenAPI 3 规范。

plugins {
      id("org.springframework.boot") version "2.7.0"
      id("org.springdoc.openapi-gradle-plugin") version "1.6.0"
}


1
2
3
4
5
6

将此插件及其运行时依赖项插件添加到构建文件时，该插件将创建以下任务：

• forkedSpringBootRun
• 生成OpenApiDocs

gradle clean generateOpenApiDocs
1

有关 的更多自定义配置，可以参考插件文档：springdoc-openapi-gradle-plugin

https://github.com/springdoc/springdoc-openapi-gradle-plugin

7. Springdoc-openapi 实例

7.1. springdoc 应用实例

• Demo Spring Boot 2 Web MVC with OpenAPI 3
• Demo Spring Boot 2 WebFlux with OpenAPI 3
• Demo Spring Boot 1 Web MVC with OpenAPI 3
• Demo Spring Boot 2 WebFlux with Functional endpoint OpenAPI 3
• Demo Spring Boot 2 和 Spring Hateoas with OpenAPI 3
• 演示 Spring Boot 2 和 Spring Cloud Gateway
• 演示 Spring Boot 2 和 Spring Cloud Function Web MVC
• 演示 Spring Boot 2 和 Spring Cloud Function WebFlux

7.2 演示应用程序的源代码

https://github.com/springdoc/springdoc-openapi-demos.git

8. 从SpringFox迁移

• 删除 springfox 和 swagger 2 依赖项。改为添加依赖项。springdoc-openapi-ui

   <dependency>
      <groupId>org.springdoc</groupId>
      <artifactId>springdoc-openapi-ui</artifactId>
      <version>1.6.14</version>
   </dependency>
1
2
3
4
5

• 将 swagger 2 注释替换为 swagger 3 注释（它已包含在依赖项中）。 招摇 3 注释的包是 .springdoc-openapi-ui``io.swagger.v3.oas.annotations
  • @Api→@Tag
  • @ApiIgnore→或或@Parameter(hidden = true)``@Operation(hidden = true)``@Hidden
  • @ApiImplicitParam→@Parameter
  • @ApiImplicitParams→@Parameters
  • @ApiModel→@Schema
  • @ApiModelProperty(hidden = true)→@Schema(accessMode = READ_ONLY)
  • @ApiModelProperty→@Schema
  • @ApiOperation(value = "foo", notes = "bar")→@Operation(summary = "foo", description = "bar")
  • @ApiParam→@Parameter
  • @ApiResponse(code = 404, message = "foo")→@ApiResponse(responseCode = "404", description = "foo")
• 如果使用对象捕获多个请求查询参数，请使用@ParameterObject
• 此步骤是可选的：仅当您有多个 bean 时，才将它们替换为 bean。Docket``GroupedOpenApi

以前：

  @Bean
  public Docket publicApi() {
      return new Docket(DocumentationType.SWAGGER_2)
              .select()
              .apis(RequestHandlerSelectors.basePackage("org.github.springshop.web.public"))
              .paths(PathSelectors.regex("/public.*"))
              .build()
              .groupName("springshop-public")
              .apiInfo(apiInfo());
  }

  @Bean
  public Docket adminApi() {
      return new Docket(DocumentationType.SWAGGER_2)
              .select()
              .apis(RequestHandlerSelectors.basePackage("org.github.springshop.web.admin"))
              .paths(PathSelectors.regex("/admin.*"))
              .apis(RequestHandlerSelectors.withMethodAnnotation(Admin.class))
              .build()
              .groupName("springshop-admin")
              .apiInfo(apiInfo());
  }
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

现在：

 @Bean
  public GroupedOpenApi publicApi() {
      return GroupedOpenApi.builder()
              .group("springshop-public")
              .pathsToMatch("/public/**")
              .build();
  }
  @Bean
  public GroupedOpenApi adminApi() {
      return GroupedOpenApi.builder()
              .group("springshop-admin")
              .pathsToMatch("/admin/**")
              .addMethodFilter(method -> method.isAnnotationPresent(Admin.class))
              .build();
  }
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

如果你只有一个 - 删除它，而是将属性添加到你的 ：Docket``application.properties

springdoc.packagesToScan=package1, package2
springdoc.pathsToMatch=/v1, /api/balance/**
1
2

• 添加类型的 bean。请参阅示例：OpenAPI

  @Bean
  public OpenAPI springShopOpenAPI() {
      return new OpenAPI()
              .info(new Info().title("SpringShop API")
              .description("Spring shop sample application")
              .version("v0.0.1")
              .license(new License().name("Apache 2.0").url("http://springdoc.org")))
              .externalDocs(new ExternalDocumentation()
              .description("SpringShop Wiki Documentation")
              .url("https://springshop.wiki.github.org/docs"));
  }
1
2
3
4
5
6
7
8
9
10
11

• 如果在代理后面提供 swagger-ui ：
  • 如何-我可以-部署-弹簧文档-openapi-ui-behind-a-reverse-proxy
• 自定义Swagger UI
  • 如何配置-swagger-UI
• 从文档中隐藏操作或控制器
  • 如何从文档中隐藏操作或控制器

9. 其他资源

9.1. 其他入门资源

• 在 GitHub 上查看项目 [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-1QF1HTXU-1676865530537)(null)]
• Springdoc-openapi演示文稿
• 贝尔东
• DZone 第 1 部分
• DZone 第 2 部分
• 扩展 Swagger 和 Spring Doc Open API
• 皮奥特明科夫斯基博客

9.2. 依赖仓库

这些库托管在 maven 中央存储库上。 可以在以下位置查看项目的访问权限：springdoc-openapi

释放：

• https://s01.oss.sonatype.org/content/groups/public/org/springdoc/

快照：

• https://s01.oss.sonatype.org/content/repositories/snapshots/org/springdoc/

10. 赞助商

springdoc-openapi在开放集体上。

如果您这个项目❤️考虑成为赞助商。

这笔钱用于支付项目费用，您的捐款将帮助项目成功生存和发展。

感谢我们的铜牌赞助商！

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-Sby13QPp-1676865635144)(null)] [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-Fxc4aC13-1676865637746)(null)] [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-LeBYJpwS-1676865635223)(null)]

10.1. 成为铜牌赞助商的好处

铜牌赞助商每月向该项目捐赠 50 美元，并获得以下好处：

• 您将收到赞助商徽章声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/Cpp五条/article/detail/616081