Swagger 注解说明

1 @Api() 用于类;表示标识这个类是swagger的资源 
 2 tags–表示说明 
 3 value–也是说明,可以使用tags替代 
 4 
 5 @ApiOperation() 用于方法;表示一个http请求的操作 
 6 value用于方法描述 
 7 notes用于提示内容 
 8 
 9 
10 @ApiParam() 用于方法,参数,字段说明;表示对参数的添加元数据(说明或是否必填等) 
11 name–参数名 
12 value–参数说明 
13 required–是否必填
14 
15 @ApiModel()用于类 ;表示对类进行说明,用于参数用实体类接收 
16 value–表示对象名 
17 
18 @ApiModelProperty()用于方法,字段; 表示对model属性的说明或者数据操作更改 
19 value–字段说明 
20 name–重写属性名字 
21 dataType–重写属性类型 
22 required–是否必填 
23 example–举例说明 
24 hidden–隐藏
25 
26 @ApiImplicitParam() 用于方法 
27 表示单独的请求参数
28 
29 @ApiImplicitParams() 用于方法,包含多个 @ApiImplicitParam 
30 name–参数ming 
31 value–参数说明 
32 dataType–数据类型 
33 paramType–参数类型 
34 example–举例说明
35 
36 @ApiIgnore
37 作用于方法上,使用这个注解swagger将忽略这个接口
  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Swagger可以通过注解的方式来描述API的请求参数。常用的注解包括: - @Api:用于描述API的基本信息,包括名称、描述、版本等信息; - @ApiOperation:用于描述API的操作,包括HTTP方法、URL、操作名称、操作描述等信息; - @ApiParam:用于描述API的请求参数,包括参数名、数据类型、是否必填、默认值、描述等信息; - @ApiImplicitParam:用于描述API的请求参数,包括参数名、数据类型、是否必填、默认值、描述等信息; - @ApiImplicitParams:用于描述API的多个请求参数,可以包含多个@ApiImplicitParam注解; - @ApiModel:用于描述API的请求或响应参数的数据模型,包括模型名、字段、描述等信息; - @ApiModelProperty:用于描述API的请求或响应参数的数据模型的字段,包括字段名、数据类型、描述等信息。 例如,以下是一个使用Swagger注解的示例: ``` @RestController @Api(tags = "用户管理") @RequestMapping("/api/users") public class UserController { @GetMapping("/{id}") @ApiOperation(value = "根据ID获取用户信息", notes = "根据用户ID获取用户信息") public User getUserById(@PathVariable Long id) { // ... } @PostMapping @ApiOperation(value = "创建用户", notes = "创建新用户") public User createUser(@ApiParam(name = "用户信息", value = "用户对象", required = true) @RequestBody User user) { // ... } } ``` 在上面的示例中,@Api注解描述了API的基本信息,@ApiOperation注解描述了API的操作信息,@ApiParam注解描述了请求参数的信息。这些注解可以帮助开发者更好地理解API的含义和用法,提高API的可读性和可维护性。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值