概述

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導入模型時，同名模型將直接被覆蓋。

編輯模型定義

控制臺入口：

1. 進入API托管->API分組菜單頁。
2. 點擊模型管理，進入模型管理頁面，點擊編輯按鈕，可對已有模型進行更新

刪除模型定義

用戶可以對分組下的模型進行刪除操作。

注意
網關不維護模型和API的關聯關系，刪除模型請謹慎操作。