详解JAVA中的@Schema注解

@Schema 注解在 Java 中用于定义 Swagger 文档中的模型属性。它是 Swagger 2.0 注解的一部分，并且通常与 SpringFox 库一起使用，以便自动生成 Swagger 文档。

以下是 @Schema 注解的一些常用属性：

• title：提供模型的简短说明。
• description：提供模型属性的详细描述。
• defaultValue：设置属性的默认值。
• required：指定该属性是否必须。
• example：提供一个属性值的例子。
• type：指定模型属性的数据类型。

下面是一个使用 @Schema 注解的简单例子：

import io.swagger.v3.oas.annotations.media.Schema;
 
public class User {
    @Schema(description = "用户的唯一标识", type = "integer", format = "int64")
    private Long id;
 
    @Schema(description = "用户名", example = "JohnDoe")
    private String username;
 
    @Schema(description = "用户的邮箱", example = "johndoe@example.com")
    private String email;
 
    // 省略 getter 和 setter 方法
}

在这个例子中，我们定义了一个简单的 User 类，并且使用 @Schema 注解为每个字段提供了描述和例子。当这个类被用于自动生成 Swagger 文档时，这些注解的属性会被用来描述 API 中的模型。