@OpenAPIDefinition
- 描述：用于定义整个 API 文档的基本信息。
- 可用于：类、接口。
- 属性：
- ：指定 注解的对象，用于描述 API 文档的基本信息。
@Info
- 描述：用于定义 API 文档的基本信息。
- 可用于：类、接口。
- 属性：
- ：API 的标题。
- ：API 的描述。
- ：API 的版本号。
- ：服务条款的 URL。
- ：指定 注解的对象，用于描述联系人信息。
- ：指定 注解的对象，用于描述许可证信息。
@Contact
- 描述：用于定义 API 文档中的联系人信息。
- 可用于：类、接口。
- 属性：
- ：联系人的名称。
- ：联系人的网址。
- ：联系人的电子邮件地址。
@License
- 描述：用于定义 API 文档中的许可证信息。
- 可用于：类、接口。
- 属性：
- ：许可证的名称。
- ：许可证的网址。
@Tag
以下注解用于描述 API 的请求方法：
@Operation
- 描述：用于描述 API 的操作。
- 可用于：方法。
- 属性：
- ：操作的摘要信息。
- ：操作的详细描述。
- ：指定 注解的对象数组，用于将操作归类到特定的分组。
- ：指定 注解的对象数组，用于描述操作的输入参数。
- ：指定 注解的对象数组，用于描述操作的响应结果。
- ：指定 注解的对象，用于描述操作的请求体。
@Parameter
- 描述：用于描述操作的输入参数。
- 可用于：方法。
- 属性：
- ：参数的名称。
- ：参数的位置，可以是 、、、 中的一种。
- ：参数的描述。
- ：参数是否必需，默认为 。
- ：指定 注解的对象，用于描述参数的数据类型。
@RequestBody
- 描述：用于描述操作的请求体。
- 可用于：方法。
- 属性：
- ：请求体是否必需，默认为 。
- ：指定 注解的对象数组，用于描述请求体的内容。
@ApiResponse
- 描述：用于描述操作的响应结果。
- 可用于：方法。
- 属性：
- ：响应的状态码。
- ：响应的描述。
- ：指定 注解的对象数组，用于描述响应的内容。
@Content
- 描述：用于描述请求体或响应的内容。
- 可用于：方法。
- 属性：
- ：内容的媒体类型。
- ：指定 注解的对象，用于描述内容的数据类型。
@Schema
- 描述：用于描述数据模型的属性。
- 可用于：方法、类、接口。
- 属性：
- ：数据模型的标题。
- ：数据模型的描述。
- ：数据模型的类型。
- ：数据模型的格式。
以下注解用于描述 API 的路径：
@Path
- 描述：用于定义路径参数。
- 可用于：方法。
- 属性：
- ：路径参数的名称。
@PathVariable
- 描述：用于描述路径参数。
- 可用于：方法的参数。
- 属性：
- ：路径参数的名称。
@RequestParam
- 描述：用于描述查询参数。
- 可用于：方法的参数。
- 属性：
- ：查询参数的名称。
- ：查询参数是否必需，默认为 。
@RequestBody
- 描述：用于描述请求体。
- 可用于：方法的参数。
以下注解用于描述 API 的响应结果：
@ApiResponse
- 描述：用于描述响应结果。
- 可用于：方法。
- 属性：
- ：响应的状态码。
- ：响应的描述。
- ：指定 注解的对象数组，用于描述响应的内容。
@Content
- 描述：用于描述响应结果的内容。
- 可用于：方法。
- 属性：
- ：内容的媒体类型。
- ：指定 注解的对象，用于描述内容的数据类型。
@Schema
- 描述：用于描述数据模型的属性。
- 可用于：方法、类、接口。
- 属性：
- ：数据模型的标题。
- ：数据模型的描述。
- ：数据模型的类型。
- ：数据模型的格式。
当使用Swagger 3注解编写API文档时，以下是一个示例代码，演示了如何使用各种注解来描述API的信息、请求参数和响应结果：
在上述示例中，我们使用了注解来分组API，注解来描述每个API操作的摘要和详细描述，注解来描述响应结果，注解来描述路径参数，注解来描述请求体，以及和注解来描述响应结果。
到此这篇swagger3 注解（swagger注解说明）的文章就介绍到这了,更多相关内容请继续浏览下面的相关推荐文章，希望大家都能在编程的领域有一番成就！版权声明：
本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如若内容造成侵权、违法违规、事实不符，请将相关资料发送至xkadmin@xkablog.com进行投诉反馈，一经查实，立即处理！
转载请注明出处，原文链接：https://www.xkablog.com/rfx/26489.html