文章目录
Swagger 是一个用于描述和文档化 RESTful API 的强大工具。随着版本演进,Swagger 从 2.x 发展到 3.x(OpenAPI 3.0),其注解也有了一些变化。下面我将详细分析两个版本的注解及其差异。
一、Swagger2 注解详解
Swagger2 使用 io.swagger.annotations
包下的注解。
1. @Api
作用:标注在控制器类上,用于描述整个控制器的作用。
/**
* @Api:描述控制器类
* tags:控制器的标签,可以有多个
* value:控制器的描述(已废弃,建议使用description)
* description:控制器的详细描述
* produces:指定返回的内容类型,如"application/json"
* consumes:指定接收的内容类型
* protocols:协议类型,如"http", "https", "ws", "wss"
* authorizations:高级特性认证配置
* hidden:是否隐藏该控制器
*/
@Api(
tags