本节重点介绍如何利用 Apifox helper 生成全面且精确的数据模型,包括模型名、字段名、字段说明、中文名、枚举等关键信息。1. 定义数据模型类#
首先,我们需要在 Java 中定义一个数据模型类。这个类通常是一个简单的 POJO (Plain Old Java Object) 或 DTO (Data Transfer Object)。例如:2. 添加字段和 Javadoc 注释#
在类中添加字段,并为每个字段添加 Javadoc 注释。这些注释将被 Apifox helper 用来生成数据模型的每个字段的说明信息。3. 使用注解增强字段信息#
可以使用各种注解来提供额外的字段信息,这些信息会被 Apifox helper 识别并包含在生成的数据模型中。4. 定义枚举类型#
对于枚举字段,可以创建一个单独的枚举类,并在字段的 Javadoc 中使用@see
标签引用它。5. 使用中文名和详细说明#
在 Javadoc 注释中,可以提供字段的中文名和更详细的说明。首先设置中文名规则field.schema.title=#titleName
,此规则的意思是当你使用@titleName
的javadoc
注释时它的值作为中文名上传至 Apifox。6. 指定字段的默认值或示例值#
可以在 Javadoc 中使用特殊的标记来指定字段的默认值或示例值。默认值规则field.defaultValue=#default
,示例值规则field.example=#example
,此规则的意思是当你使用@default
的javadoc
注释时它的值作为默认值,使用@example
的javadoc
注释时它的值作为示例值。