Swagger @Tag 注解的作用和示例

Swagger @Tag 注解的作用是为 API 操作添加一个或多个标签。标签可以在 Swagger UI 中使用,以帮助用户更好地组织和查找 API 操作。

下面是一个 @Tag 注解的示例:

@RestController
@RequestMapping("/users")
@Tag(name = "User Management", description = "APIs for managing user accounts")
public class UserController {

    @GetMapping("/{id}")
    @Tag(name = "User Retrieval", description = "APIs for retrieving user accounts")
    public User getUser(@PathVariable Long id) {
        // ...
    }

    @PostMapping("/")
    @Tag(name = "User Creation", description = "APIs for creating user accounts")
    public User createUser(@RequestBody User user) {
        // ...
    }

    // ...
}

在上面的示例中,@Tag 注解用于在类级别和方法级别为 API 操作添加标签。在 Swagger UI 中,”User Management” 标签将显示在 “/users” 控制器的顶部,而 “User Retrieval” 和 “User Creation” 标签将显示在相应的 GET 和 POST 操作上方。