swagger注解

1 controller注解

  1. @api注解放在controller类上,value中填写此类名,description里放描述
@Api(value = "WxController", description = "微信相关,包括获取微信用户信息")
public class WxController {
    ....
}
  1. 参数注解 @ApiImplicitParam 单个参数使用,是输入参数的消息描述和限制
    注意paramType的使用,如果是使用restful风格传参,paramType一定要写成:paramType = “path”
@ApiOperation(value = "向邮箱发送验证码,status=200可用",notes = "向邮箱发送验证码")
@ApiImplicitParam(name = "email",value = "邮箱",required = true,dataType = "String",paramType = "path")
@GetMapping("sendCodeToEmail/{email:.+}")
public HealthResult sendCodeToEmail(@PathVariable(value = "email") String email){
    HealthResult result = userService.sendCodeToEmail(email);
    return result;
}
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Swagger注解是一种用于编写API文档的注解,可以帮助开发人员设计、构建、记录和使用RESTful Web服务。以下是常用的Swagger注解及其作用: 1. @Api:用于类上,表示标识这个类是swagger的资源。 2. @ApiOperation:用于方法上,表示一个http请求的操作。 3. @ApiParam:用于参数上,用来标明参数信息。 4. @ApiModel:用于类上,表示对类进行说明,用于参数用实体类接收。 5. @ApiModelProperty:用于属性上,表示对model属性的说明。 6. @ApiIgnore:用于类或者方法上,表示这个类或者方法不被swagger处理。 7. @ApiError:用于方法上,表示一个错误的响应信息。 8. @ApiImplicitParam:用于方法上,表示单独的请求参数。 9. @ApiImplicitParams:用于方法上,包含多个 @ApiImplicitParam。 10. @ApiResponses:用于方法上,表示一个请求的响应信息。 下面是一个使用Swagger注解的示例: ```java @RestController @RequestMapping("/users") @Api(value = "用户管理", tags = "用户管理") public class UserController { @Autowired private UserService userService; @ApiOperation(value = "获取用户列表", notes = "获取所有用户列表") @GetMapping("") public List<User> getUserList() { return userService.getUserList(); } @ApiOperation(value = "创建用户", notes = "根据User对象创建用户") @ApiImplicitParam(name = "user", value = "用户实体user", required = true, dataType = "User") @PostMapping("") public String postUser(@RequestBody User user) { userService.postUser(user); return "success"; } @ApiOperation(value = "更新用户", notes = "根据User对象更新用户") @ApiImplicitParam(name = "user", value = "用户实体user", required = true, dataType = "User") @PutMapping("/{id}") public String putUser(@PathVariable Long id, @RequestBody User user) { userService.putUser(id, user); return "success"; } @ApiOperation(value = "删除用户", notes = "根据id删除用户") @ApiImplicitParam(name = "id", value = "用户id", required = true, dataType = "Long") @DeleteMapping("/{id}") public String deleteUser(@PathVariable Long id) { userService.deleteUser(id); return "success"; } } ```
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值