数据模型
数据模型与编程语言里的数据结构类似，主要使用在接口设计的返回响应和 JSON 类型的 Body 参数。数据模型可在同一接口库下的接口间复用，实现接口定义规范统一的同时维护也更加便捷。通常会将项目中公共信息，如用户信息、地址、订单信息等设为数据模型，在接口设计时引用。
添加模型分组
在接口库下新建数据模型前，可以根据实际需要添加模型分组以便按分组管理不同类型的数据模型。
- 登录团队的具体项目后，点击工作台左侧「API 管理」->「API 设计」。在「数据模型」页面点击
+，在下拉菜单中根据实际需要点击「添加分组」，通过分组将数据模型进行分组管理。
- 如需创建子分组，在模型分组右侧点击
···，在下拉菜单中点击「添加子分组」。
添加模型
- 在「API 设计」->「数据模型」页面可以根据实际需要在具体分组下点击「添加数据模型」创建模型，按分组管理不同数据模型间的关系。
- 在「数据模型」区域配置模型的字段是否必填、数据类型、格式约束、示例值等，还可以为字段添加说明，提升接口文档可读性。
- 配置数据类型时，您可以根据实际需要引用数据模型。当引用的数据模型变化了不再适用时，则可在编辑数据模型时解除对数据模型的引用。解除对数据模型的引用将复制原引用数据结构，不影响继续使用。
- 在「数据模型」区域点击「导入 JSON 自动识别」，通过 JSON 数据自动识别生成数据结构可快速从已有接口定义，快捷生成数据模型。
- 在「数据模型」区域点击「预览」，查看设计数据模型的实际效果后，点击「确定」。在「数据模型」页面左侧选择需查看的数据模型，在右侧页面可以查看数据模型的详细信息。
编辑模型
在「API 设计」->「数据模型」页面左侧选择需要编辑的数据模型，在页面右上角点击「编辑数据模型」，在「编辑数据模型」页面可更新基础信息、模型信息。
问题反馈 >
2023-10-12最近更新感谢反馈有用
感谢反馈没用
在阅读中是否遇到以下问题？*
您希望我们如何改进？*
如果您希望得到回复，请留下您的邮箱地址。
