全部产品

创建数据模型

更新时间:2020-08-03 15:32:14

API 网关支持将 API 服务的请求与响应参数定义成数据模型。继而在创建 API 时,可以直接引用数据模型的配置参数,提高参数设置效率。本文介绍如何快速创建 API 参数数据模型。

操作步骤

  1. 进入 API 网关控制台页面,在左侧导航栏中选择 API 发布 > 数据模型
  2. 在数据模型列表页,点击列表右上方的 创建数据模型 按钮。
  3. 在新打开的 创建数据模型 页面中,配置如下信息:
    • 模型名称:必填,用于识别数据模型,需保证唯一性。支持数字、字母、下划线,32 个字符以内,以字母或下划线开头。
    • 模型描述:选填,用于描述该数据模型的业务意义或使用范围等,64 个字符以内,可为空。
    • 模型参数:必填,根据业务需要配置相应的模型参数。
      1. 点击 添加 按钮,添加需要的参数信息:
        • 参数名称:必填,参数的唯一标识。
        • 类型:必填,可选的参数类型包括 String、Int、Long、Double、Float、Boolean、List、Object、Map。
        • 默认值:选填,在 API 请求的参数值为空时使用的默认值。默认值类型必须和参数类型一致。
        • 描述:选填,用于描述参数的业务意义等,可为空。
      2. 添加完成后,点击 保存,才可继续添加其他参数。
        创建数据模型
  4. 确认信息无误后,点击 创建

数据模型创建成功后,后续在创建 API 配置请求/响应参数时,您可以直接选择对应的数据模型进行绑定,如下图所示:
使用数据模型

相关链接