模型管理

模型介绍

模型用于描述HTTP协议的请求数据和响应数据。API网关通过使用JSON Schema定义模型，用来描述用户API约定数据的组织方式，比如参数或者返回值有哪些字段，这些字段的取值范围等。同时，通过定义模型，并在用户创建的API中加以引用，用户在API的SDK导出时，关联的Model会自动生成对应的POJO类。这样可以增强用户传入参数的便利性，同时可以方便用户反序列化返回的数据。

API网关模型定义基于JSON架构草案4的规范，但存在一定的条件限制：

• 仅支持创建元素属性为Object类型的JSON Schema

• $ref仅支持本用户的内部Model引用。Model的‘ref’引用地址可以通过模型管理的资源标识获取。‘ref’不支持循环引用。

模型定义示例

1.简单的模型定义

2.较复杂的模型定义

3.带引用的模型定义

• Model资源属于分组级别，网关只允许引用同分组下定义的其它Model。

• 由于Model的引用相对灵活，在创建或编辑Model时，网关不会校验引用的正确性，只有在具体使用该Model的场景下会进行校验。

操作说明

创建模型

1）点击分组管理-模型管理，进入模型管理界面来创建模型

2）弹出创建模型弹窗，填写模型名称、描述、定义信息

3）点击确定的，完成模型创建。可在模型列表查看刚刚创建的模型。

查看和修改模型

• 完成模型的创建后，可以在模型管理界面点击查看所需的模型。在模型的详情页，可以看到模型的名称，模型的定义，以及系统为其分配的资源标识。API网关模型间可以通过‘$ref:{资源标识}’来实现模型间的项目引用。

• 如果用户希望对当前模型的信息进行修改，可以点击右上角修改按钮完成模型的修改。需要注意的是：模型的资源标识不随模型的更改发生改变

删除模型

用户可以对分组下的模型进行删除操作。注意:API网关不维护模型和API的关联关系，删除模型时可能会引起线上API的SDK导出失败等问题。因此，删除模型请谨慎操作