swagger中的所有注释及含义

时间: 2023-04-09 12:00:56 浏览: 156
JAR

Swagger的相关配置与注解的使用

Swagger中的注释包括以下几种: 1. @Api:用于描述整个API的信息,包括API的名称、描述、作者等。 2. @ApiOperation:用于描述API的操作,包括API的名称、描述、请求方式、请求参数、响应参数等。 3. @ApiParam:用于描述API的请求参数,包括参数名称、参数类型、参数描述等。 4. @ApiModel:用于描述数据模型,包括模型名称、模型属性等。 5. @ApiModelProperty:用于描述数据模型的属性,包括属性名称、属性类型、属性描述等。 6. @ApiResponse:用于描述API的响应信息,包括响应状态码、响应描述等。 7. @ApiResponses:用于描述API的多个响应信息。 以上注释的含义可以在Swagger文档中查看,也可以在Swagger UI中查看。
阅读全文

相关推荐