模型管理 概述 API分组模型主要用于对HTTP协议的请求数据和响应结果进行描述。网关通过在API分组中定义JSON Schema模型,来规范用户API中数据的组织方式,例如请求参数或返回值的字段等。目前分组模型主要用于在API定义的请求body或返回结果中引用,在API和SDK导出时,关联的模型会生成对应的文档内容,方便用户查看。 分组模型定义需要遵循规则: 1. 定义需符合Json Schema格式; 2. 仅支持创建元素属性为object类型的JSON Schema; 3. 目前暂不支持模型间的引用,即不支持模型定义中通过$ref引用其他模型。 可参考以下模型定义: { "required": [ "name" ], "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "name": { "pattern": "^d{3}d{2}d{4}$", "type": "string" }, "dog": { "type": "object", "properties": { "id": { "format": "int64", "maximum": 100, "exclusiveMaximum": true, "type": "integer" }, "name": { "maxLength": 10, "type": "string" } } } } } 创建模型定义 控制台入口: 1. 进入API托管>API分组菜单页。 2. 点击模型管理,进入模型管理页面,点击创建按钮,填写模型名称,定义和描述进行创建。 Swagger导入创建模型: 网关还支持通过导入Swagger定义的方式创建模型,Swagger文件中的Model内容会在该分组下自动生成模型。 注意 通过Swagger导入模型时,同名模型将直接被覆盖。