SWAGGER注解说明

旧城等待， 2024-03-31 16:55 24阅读 0赞

@ApiModelProperty:对象属性,用在出入参数对象的字段上

@Api:用于controller类上

@ApiOperation:用在controller的方法上

@ApiResponses:用在controller的方法上

@ApiResponse:用在 @ApiResponses里边

@ApiImplicitParams:用在controller的方法上

@ApiImplicitParam:用在@ApiImplicitParams的方法里边

@ApiModel:用在返回对象类上

eg1:

@ApiOperation("信息软删除")

@ApiResponses(\{ @ApiResponse(code = CommonStatus.OK, message = "操作成功"),

@ApiResponse(code = CommonStatus.EXCEPTION, message = "服务器内部异常"),

@ApiResponse(code = CommonStatus.FORBIDDEN, message = "权限不足") \})

@ApiImplicitParams(\{ @ApiImplicitParam(paramType = "query", dataType = "Long", name = "id", value = "信息id", required = true) \})

@RequestMapping(value = "/remove.json", method = RequestMethod.GET, produces = MediaType.APPLICATION\_JSON\_UTF8\_VALUE)

public RestfulProtocol remove(Long id) \{

@ApiModelProperty(value = "标题")

private String title;

@RequestMapping(value = "/findById1/\{id\}", method = RequestMethod.GET, produces = MediaType.APPLICATION\_JSON\_UTF8\_VALUE)

@ApiImplicitParams(\{ @ApiImplicitParam(paramType = "body", dataType = "MessageParam", name = "param", value = "信息参数", required = true) \})

@RequestMapping(value = "/findById3", method = RequestMethod.POST, produces = MediaType.APPLICATION\_JSON\_UTF8\_VALUE, consumes = MediaType.APPLICATION\_JSON\_VALUE)

@PathVariable(name = "id") Long id

@Api：

作用在类上，用来标注该类具体实现内容。表示标识这个类是swagger的资源 。  
参数：  
1. tags：可以使用tags()允许您为操作设置多个标签的属性，而不是使用该属性。  
2. description：可描述描述该类作用。

@ApiImplicitParam：

作用在方法上，表示单独的请求参数  
参数：  
1. name ：参数名。  
2. value ： 参数的具体意义，作用。  
3. required ： 参数是否必填。  
4. dataType ：参数的数据类型。  
5. paramType ：查询参数类型，这里有几种形式：

<table> 
 <thead> 
 <tr> 
 <td> 类型 </td> 
 <td> 作用 </td> 
 </tr> 
 </thead> 
 <tbody> 
 <tr> 
 <td> path </td> 
 <td> 以地址的形式提交数据 </td> 
 </tr> 
 <tr> 
 <td> query </td> 
 <td> 直接跟参数完成自动映射赋值 </td> 
 </tr> 
 <tr> 
 <td> body </td> 
 <td> 以流的形式提交 仅支持POST </td> 
 </tr> 
 <tr> 
 <td> header </td> 
 <td> 参数在request headers 里边提交 </td> 
 </tr> 
 <tr> 
 <td> form </td> 
 <td> 以form表单的形式提交 仅支持POST </td> 
 </tr> 
 </tbody> 
</table>

@ApiImplicitParams：

用于方法，包含多个 @ApiImplicitParam：  
例：

@ApiImplicitParams(\{

@ApiImplicitParam(name = "id", value = "book's name", required = true, dataType = "Long", paramType = "query"),

@ApiImplicitParam(name = "date", value = "book's date", required = false, dataType = "string", paramType = "query")\})

@ApiModel：

用于类，表示对类进行说明，用于参数用实体类接收；

@ApiModelProperty：

用于方法，字段 ，表示对model属性的说明或者数据操作更改  
例：

@ApiModel(value = "User", description = "用户")

public class User implements Serializable\{

private static final long serialVersionUID = 1546481732633762837L;

/\*\*

\* 用户ID

\*/

@ApiModelProperty(value = "用户ID", required = true)

@NotEmpty(message = "\{id.empty\}", groups = \{Default.class,New.class,Update.class\})

protected String id;

/\*\*

\* code/登录帐号

\*/

@ApiModelProperty(value = "code/登录帐号")

@NotEmpty(message = "\{itcode.empty\}", groups = \{Default.class,New.class,Update.class\})

protected String itcode;

/\*\*

\* 用户姓名

\*/

@ApiModelProperty(value = "用户姓名")

@NotEmpty(message = "\{name.empty\}", groups = \{Default.class,New.class,Update.class\})

protected String name;

@ApiOperation：

用于方法，表示一个http请求的操作 。

@ApiOperation(value = "获取图书信息", notes = "获取图书信息", response = Book.class, responseContainer = "Item", produces = "application/json")

@ApiImplicitParams(\{

@ApiImplicitParam(name = "id", value = "book's name", required = true, dataType = "Long", paramType = "query"),

@ApiImplicitParam(name = "date", value = "book's date", required = false, dataType = "string", paramType = "query")\})

@RequestMapping(value = "/\{id\}", method = RequestMethod.GET)

@ResponseBody

public Book getBook(@PathVariable Long id, String date) \{

return books.get(id);

@ApiResponse：

用于方法，描述操作的可能响应。

@ApiResponses：

用于方法，一个允许多个ApiResponse对象列表的包装器。  
例：

@ApiResponses(value = \{

@ApiResponse(code = 500, message = "2001:因输入数据问题导致的报错"),

@ApiResponse(code = 500, message = "403:没有权限"),

@ApiResponse(code = 500, message = "2500:通用报错（包括数据、逻辑、外键关联等，不区分错误类型）")\})

@ApiParam：

用于方法，参数，字段说明，表示对参数的添加元数据（说明或是否必填等）

@Authorization：

声明要在资源或操作上使用的授权方案。

@AuthorizationScope：

介绍一个OAuth2授权范围。

@ResponseHeader：

响应头设置，使用方法

SWAGGER注解说明

发表评论取消回复

还没有评论，来说两句吧...

相关阅读

相关 swagger2 注解说明

相关 SWAGGER注解说明

相关 Swagger2-注解说明

相关 swagger2 注解说明 ( @ApiImplicitParams )

相关 Swagger 常用注解说明

相关 swagger2 注解说明文档

相关 swagger常用注解说明

相关 Swagger常用注解说明

相关 swagger2 注解整体说明

相关 swagger常用注解说明