常用注解如下:
- @Api 定义API的基本信息,如标题、描述等。 在Controller类上使用,指定API的基本信息。
- @ApiOperation 定义API的操作,如GET、POST等。 在Controller方法上使用,指定该方法的操作信息。
- @ApiParam 定义方法参数的信息,如名称、描述等。 在Controller方法的参数上使用,指定参数的信息。
- @ApiModel 定义数据模型的信息。 在DTO类上使用,指定数据模型的信息。
- @ApiModelProperty 定义数据模型属性的信息,如名称、描述等。 在DTO类的属性上使用,指定属性的信息。
- @ApiResponses 定义方法返回的HTTP响应。 在Controller方法上使用,指定方法的返回响应信息。
-
@ApiResponse 定义单个HTTP响应的信息。 在@ApiResponses
注解内使用,指定单个HTTP响应的信息。 - @ApiIgnore 忽略该API,不会在文档中显示。 在Controller类或方法上使用,忽略指定的API。
- @ApiImplicitParam 定义方法的参数,如路径参数、请求参数等。 在Controller方法上使用,指定方法的参数信息。
- @ApiImplicitParams 定义多个方法参数。 在Controller方法上使用,指定多个参数的信息。
- @ApiError 定义API可能出现的错误。 在Controller方法上使用,指定可能出现的错误信息。
- @ApiErrors 定义多个API可能出现的错误。 在Controller方法上使用,指定多个可能出现的错误信息。