@Api注解是Swagger的核心注解之一,用于描述一个API的基本信息。

@Api注解的常用属性及作用如下:

  1. value:API的简要描述,可以用中文或英文描述API的功能。

  2. tags:API的标签,可以用于对API进行分类。可以使用数组来指定多个标签。

  3. description:API的详细描述,可以用中文或英文描述API的功能、参数、返回值等信息。

  4. basePath:API的基础路径,可以用于指定API的公共前缀。例如,如果所有API的路径都以"/api"开头,可以将basePath设置为"/api"。

  5. produces:API的响应内容类型,可以是一个或多个MIME类型。例如,可以设置为"application/json"表示API的响应内容是JSON格式的数据。

  6. consumes:API的请求内容类型,可以是一个或多个MIME类型。例如,可以设置为"application/json"表示API的请求内容是JSON格式的数据。

  7. protocols:API支持的协议,可以是一个或多个协议。例如,可以设置为"http"表示API支持HTTP协议。

  8. authorizations:API的安全授权配置,可以用于对API进行身份验证和权限控制。可以使用数组来指定多个授权配置。

以上是@Api注解的常用属性及作用,根据实际需求可以选择性地使用这些属性来描述API


原文地址: https://www.cveoy.top/t/topic/hGBW 著作权归作者所有。请勿转载和采集!

免费AI点我,无需注册和登录