@Api 和 @ApiOperation的使用

最新推荐文章于 2025-04-05 14:19:02 发布

stjl.xyz

最新推荐文章于 2025-04-05 14:19:02 发布

阅读量473

点赞数 3

分类专栏： ruoyi 文章标签： java 服务器

本文链接：https://blog.youkuaiyun.com/weixin_43652507/article/details/140301881

版权

ruoyi 专栏收录该内容

10 篇文章

订阅专栏

下面是一个简单的REST控制器示例，使用中文注释：

@RestController
@RequestMapping("/api")
@Api(value = "用户管理系统", description = "关于用户管理系统的操作")
public class UserController {

    @GetMapping("/users")
    @ApiOperation(value = "查看可用用户列表", response = List.class)
    public List<String> getUsers() {
        return Arrays.asList("用户1", "用户2", "用户3");
    }

    @GetMapping("/hello")
    @ApiOperation(value = "问候用户", notes = "这个API会向用户问好")
    public String sayHello() {
        return "你好，用户！";
    }
}

@Api注解用于类级别，描述该控制器的功能和目的。value属性提供了控制器的简短描述，而description属性提供了更详细的描述。
@ApiOperation注解用于方法级别，描述具体API的功能。value属性提供了API的简短描述，而notes属性可以提供更详细的信息。response属性指定了返回类型。