@ApiOperation用法

作用:注解@ApiOperation是用来构建Api文档

1.引入依赖
在pom文件中引入依赖

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.2.2</version>
</dependency>

2.用法

  1. 使用于在方法上,表示一个http请求的操作
  2. @ApiOperation(value = “接口说明”, httpMethod = “接口请求方式”, response =
    “接口返回参数类型”, notes = “接口发布说明”;其他参数可参考源码;

3.具体例子

    @ApiOperation(value="获取用户列表", notes="")
    @RequestMapping(value={""}, method=RequestMethod.GET)
    public List<User> getUserList() {
        List<User> r = new ArrayList<User>(users.values());
        return r;
    }

  • 16
    点赞
  • 31
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
@ApiOperation是Swagger注解之一,用于API接口文档的生成。它可以标注在Controller类或Controller方法上,用于描述API接口的作用、参数、返回值等信息。具体使用方法如下: 1. 在Controller类上标注@Api注解,用于描述Controller的作用。 2. 在Controller方法上标注@ApiOperation注解,用于描述方法的作用。 3. 使用@ApiParam注解标注Controller方法的参数,用于描述参数的作用、类型、是否必填等信息。 4. 使用@ApiResponses注解标注Controller方法的返回值,用于描述返回值的类型、状态码等信息。 例如: ```java @Api(value = "用户管理接口", tags = {"用户管理接口"}) @RestController @RequestMapping("/user") public class UserController { @ApiOperation(value = "获取用户信息接口", notes = "根据用户ID查询用户信息") @ApiImplicitParam(name = "userId", value = "用户ID", dataType = "int", required = true) @GetMapping("/{userId}") public User getUserInfo(@PathVariable Integer userId) { return userService.getUserInfo(userId); } @ApiOperation(value = "添加用户接口", notes = "添加用户信息") @ApiImplicitParams({ @ApiImplicitParam(name = "user", value = "用户信息", dataType = "User", required = true), @ApiImplicitParam(name = "token", value = "用户权限Token", dataType = "String", required = true) }) @PostMapping("/") public Result addUser(@RequestBody User user, @RequestParam String token) { return userService.addUser(user, token); } @ApiOperation(value = "修改用户接口", notes = "根据用户ID修改用户信息") @ApiImplicitParams({ @ApiImplicitParam(name = "userId", value = "用户ID", dataType = "int", required = true), @ApiImplicitParam(name = "user", value = "用户信息", dataType = "User", required = true), @ApiImplicitParam(name = "token", value = "用户权限Token", dataType = "String", required = true) }) @PutMapping("/{userId}") public Result updateUser(@PathVariable Integer userId, @RequestBody User user, @RequestParam String token) { return userService.updateUser(userId, user, token); } @ApiOperation(value = "删除用户接口", notes = "根据用户ID删除用户信息") @ApiImplicitParams({ @ApiImplicitParam(name = "userId", value = "用户ID", dataType = "int", required = true), @ApiImplicitParam(name = "token", value = "用户权限Token", dataType = "String", required = true) }) @DeleteMapping("/{userId}") public Result deleteUser(@PathVariable Integer userId, @RequestParam String token) { return userService.deleteUser(userId, token); } } ``` 在上面的例子中,我们使用了@Api、@ApiOperation、@ApiImplicitParam、@ApiImplicitParams注解来描述Controller类和Controller方法的作用、参数、返回值等信息。这些注解可以帮助我们自动生成API接口文档,方便开发人员查阅和使用。
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值