@ApiModel
是 Swagger (现在通常被称为 OpenAPI) 中的一个注解,用于在 RESTful Web 服务中描述 API 的模型。Swagger 允许开发人员为 RESTful Web 服务生成、描述、调用和可视化 API 文档。通过使用 Swagger 的注解(如 @ApiModel
),开发人员可以自动地生成这些文档,而无需手动编写和维护它们。
@ApiModel
注解通常用于 Java 类的顶部,这些类代表 API 响应或请求体中的模型对象。这个注解提供了关于模型的元数据,如模型的名称、描述和子类型等。
以下是一个简单的例子:
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
@ApiModel(value = "UserModel", description = "A model representing a user")
public class User {
@ApiModelProperty(value = "The user's ID", required = true)
private Long id;
@ApiModelProperty(value = "The user's name", required = true)
private String name;
// Getters and setters...
}
在这个例子中,@ApiModel 注解被用于 User 类,并为它提供了两个属性:
value
:这是模型的名称,将在生成的 Swagger 文档中显示。description
:这是对模型的描述,也将在生成的 Swagger 文档中显示。
@ApiModelProperty
注解则用于类中的字段,并为它们提供了额外的元数据,如字段的描述和是否必需等。
通过使用这些注解,你可以更容易地为你的 RESTful Web 服务生成和维护 API 文档。