文档是构建 REST API 的重要组成部分。在本教程中，我们将介绍 Spring Doc，它可简化 API 文档的生成和维护，这些文档基于 OpenAPI 3 规范，适用于 Spring Boot 3.x 应用程序。
Spring Boot 3.x 要求使用 springdoc-openapi version 2：
正确设置依赖后，我们就可以运行应用程序，并在 路径访问 OpenAPI 描述，这是默认路径：
此外，我们还可以使用 属性在 中自定义描述的路径。例如，我们可以将路径设置为 ：
然后，我们就可以通过以下网址访问文档描述：
OpenAPI 描述定义默认为 JSON 格式。对于 格式，我们可以从以下网址获取定义：
除了生成 OpenAPI 3 规范之外，我们还可以将 与 Swagger UI 集成，以与我们的 API 规范进行交互并测试端点。
Springdoc-openapi 依赖项中已经包含了 Swagger UI，因此我们可以通过如下路径访问 API 文档：
springdoc-openapi 库还支持 swagger-ui properties。这些属性可作为 Spring Boot 属性使用，前缀为 。
例如，我们可以通过更改 s 文件中的 属性，自定义 API 文档的路径：
现在我们的 API 文档可以通过 访问。
再比如，我们可以使用 属性根据 HTTP 方法对 API 路径进行排序：
假设我们的应用程序有一个管理 的 controller：
然后，当我们运行应用程序时，就可以在以下位置查看文档：
让我们深入到 端点，查看其请求和响应的详细信息：
我们还可以在 Spring WebFlux 应用上轻松整合 springdoc-openapi 和 Swagger UI（ properties 也可用）。只需要在 文件中添加 springdoc-openapi-webflux-ui 依赖：
Spring Data JPA 与 Spring MVC 无缝集成。例如，对 的支持：
自 springdoc-openapi v1.6.0 起， 支持已开箱即用。、 和 查询参数会添加到生成的文档中：
springdoc-openapi 库提供了一个 Maven 插件 springdoc-openapi-maven-plugin，可生成 JSON 和 YAML 格式的 OpenAPI 描述。
插件与 插件配合使用。Maven 会在 阶段运行 openapi 插件。
让我们看看如何在 中配置插件：
我们还可以对插件进行配置，以使用自定义值：
插件配置的参数如下：
- ：访问 JSON 格式文档的 URL，默认为
- ：存储定义的文件名；默认为
- ：文档存储目录的绝对路径；默认为
当我们的 model 包含 JSR-303 Bean 验证注解（如 、、、 和 ）时， 库会使用它们为相应的约束生成额外的 schema 文档。
让我们用图书 bean 来举个例子：
现在，为 Bean 生成的文档信息量更大了：
在 类中的方法上使用 会自动为 response code 生成文档。在这个 类中，两个方法都注解了 ：
因此，我们现在可以看到 response code 和 的文档：
接下来，让我们看看如何使用几个 OpenAPI 专用注解 为我们的 API 添加一些说明。
我们使用 和 对 controller 的 端点进行注解：
效果如下：
我们可以看到，我们添加到 中的文本被置于 API 操作层。同样，在 容器注解中添加到各种 元素中的说明也在这里可见，从而为我们的 API 响应增添了意义。
我们没有为上述 和 响应定义任何 schema。由于我们为它们定义了一个空 ，因此只显示了它们的描述。
Spring Boot 2.x 起，就为 Kotlin 提供了一流的支持。由于我们使用的是 Spring Boot 3.x 版本，因此 SpringDoc 支持用 Kotlin 编写的应用程序。
我们将在 Kotlin 中创建一个简单的 API，以了解其实际效果。
完成初始设置后，我们将添加一个 data class 和一个 controller。我们将把它们添加到 Boot 应用程序的一个子包中，这样当程序运行时，它就会同时加载我们的 和之前的 ：
现在，当我们点击 API 文档 URL 时，也会看到 Foo API：
为了增强对 Kotlin 类型的支持，我们可以添加此依赖项：
之后，我们的 schema 显示的信息更加详细，就像我们添加 JSR-303 Bean Validation 时一样：
在本文中，我们学习了在项目中设置 springdoc-openapi。然后，我们了解了如何将 springdoc-openapi 与 Swagger UI 集成。最后，我们还了解了如何在 Spring Webflux 项目中实现这一功能。
接下来，我们使用 springdoc-openapi Maven 插件为我们的 API 生成 OpenAPI 定义，并了解了如何从 Spring Data 公开分页和排序信息。之后，我们了解了 springdoc-openapi 如何使用 JSR 303 Bean validation 注解和 类中的 注解自动生成文档。
我们还学习了如何使用一些 OpenAPI 特有的注解为我们的 API 添加说明。最后，我们还了解了 OpenAPI 对 Kotlin 的支持。
Springdoc-openapi 可根据 OpenAPI 3 规范生成 API 文档。此外，它还为我们处理了 Swagger UI 配置，使 API 文档的生成变得相当简单。
参考：
版权声明：
本文来源网络，所有图片文章版权属于原作者，如有侵权，联系删除。
本文网址：https://www.mushiming.com/mjsbk/14888.html