当我们使用Swagger生成验证时，我们通常使用基本规范。然而，我们可能需要添加Spring自定义验证注解。
本教程将教授如何使用这些验证生成模型和REST API，同时重点介绍OpenAPI服务器生成器，而不是约束验证器。
在设置中，我们将使用之前的Baeldung教程从OpenAPI 3.0.0定义生成服务器。接下来，我们将添加一些自定义验证注解以及所有所需的依赖项。
假设我们有PetStore API的OpenAPI定义，我们需要为REST API和描述的模型_Pet_添加自定义验证。
作为优秀的开发者，我们知道文档对于构建REST API至关重要，因为它帮助API的用户无缝工作。如今，大多数Java开发者都在使用Spring Boot。截至今日，有两种工具可以通过Springfox和SpringDoc简化Swagger API文档的生成和维护。
在本教程中，我们将讨论如何通过这些工具默认提供的Swagger-UI URL前缀进行修改。
首先，我们来查看如何使用OpenAPI 3.0设置REST API文档。
Swagger是一套用于设计、描述和记录RESTful API的工具集。
在本教程中，我们将探讨如何在Java中解析OpenAPI文档文件并提取其各种组件。
Swagger本质上是一套开源的规则、规范和工具集，用于开发和描述REST API。然而，随着新标准和规范的演变，这些规范现在被重命名为OpenAPI规范（OAS）。
OpenAPI规范标准化了如何创建API设计文档。 它创建了一个我们可以轻松开发和使用API的RESTful接口。API规范有效地映射了与之相关的所有资源和操作。
我们可以将Swagger UI用作一个平台，以方便的方式可视化和与API接口交互。它是一个强大的工具，可以以最少的配置生成API结构。
在本文中，我们将重点关注使用Swagger与Spring Boot REST API。具体来说，我们将探讨在Swagger UI中隐藏请求字段的不同方法。
为了简单起见，我们将创建一个基本的Spring Boot应用程序，并使用Swagger UI探索API。
让我们创建一个简单的_ArticleApplication_，使用Spring Boot。我们使用_ArticlesController_公开两个API。我们希望使用GET API接收与所有文章相关的详细信息。
在本文中，我们将编写一个允许为同一响应代码返回两个不同对象的API规范。我们将演示如何使用该规范生成Java代码和Swagger文档。
让我们定义两个对象。一辆汽车（Car）具有所有者和车牌作为属性，两者都是字符串类型。另一方面，自行车（Bike）具有所有者和速度。速度是一个整数。
使用OpenAPI，这些定义对应于以下描述：
Car:
type: object
properties:
owner:
type: string
plate:
type: string
Bike:
type: object
properties:
owner:
type: string
speed:
type: integer
在本文中，我们将看到如何将Swagger API导入Postman。
Swagger是一个开源的规则集、规范和工具集，用于开发和描述REST API。然而，2021年之后，OpenAPI指的是行业标准规范，而Swagger指的是工具。
Postman是一个用于构建和使用API的平台。Postman简化了API生命周期的每一步，并简化了协作。我们可以使用Postman在不编写任何代码的情况下测试我们的API。
我们可以使用独立应用程序或浏览器扩展。
我们可以与任何现有应用程序一起工作，或者我们可以从头开始创建一个简单的应用程序，该程序公开REST API。
在本教程中，我们将讨论Swagger的@Operation和@ApiResponse注解之间的主要区别。
创建REST API时，同样重要的是创建其适当的规范。此外，这样的规范应该是可读的、易于理解的，并提供所有必要的信息。更重要的是，文档应该描述对API所做的每一个更改。手动创建REST API文档既耗时又费时。幸运的是，像Swagger这样的工具可以帮助我们完成这个过程。
Swagger是围绕OpenAPI规范构建的一套开源工具集。它可以帮助我们设计、构建、文档化和使用REST API。
Swagger规范是REST API文档化的标准。使用Swagger规范，我们可以描述我们的整个API，例如公开的端点、操作、参数、认证方法等。
在本教程中，我们将学习如何使用_swagger-maven-plugin_在Swagger中记录枚举，并在swagger编辑器中验证生成的JSON文档。
Swagger是一个开源工具，用于定义基于REST的API。在当今世界，大多数组织都在向微服务和API优先方法发展。Swagger在设计和记录API方面非常有用。它还提供了各种工具，如Swagger编辑器、Swagger UI和Swagger CodeGen来协助API开发。
此外，Swagger是_OpenAPI_规范或_OAS_的实现，它定义了REST API开发的一套标准；因此，它帮助全球组织标准化编写API的过程。
在本教程中，我们将学习多种方法来配置Spring Boot应用程序中的Swagger，以隐藏由_BasicErrorController_暴露的路径。
本文不会涵盖使用Spring Boot和Swagger-UI开始的基本配置。我们可以使用已经配置好的项目，或者按照“使用Spring REST API设置Swagger 2”的指南来创建基本配置。
如果我们的代码包含一个_BasicErrorController_，Swagger默认会将其所有端点也包含在生成的文档中。 我们需要提供自定义配置来移除不需要的控制器。
在本教程中，我们将展示如何使用Swagger注解使我们的文档更加描述性。首先，我们将学习如何为API的不同部分添加描述，比如方法、参数和错误代码。然后我们将看到如何添加请求/响应示例。
我们将创建一个简单的产品API，提供创建和获取产品的方法。
从头开始创建REST API，我们可以按照Spring Docs的这个教程使用Spring Boot创建RESTful web服务。
接下来将是为项目设置依赖项和配置。我们可以按照本文的步骤为Spring REST API设置Swagger 2。