全部产品

创建参数映射

更新时间:2020-07-21 14:29:29

API 网关支持参数映射。参数映射是将请求或响应参数中的不规范或者不统一的参数,映射为客户端或者服务端期望的应答的参数。该功能常用于多部门协同时,通过 API 网关实现参数统一规范,以及统一错误码等场景。

操作步骤

  1. 进入 API 网关控制台页面,在左侧导航栏中选择 API 发布 > 参数映射
  2. 在参数映射列表页,点击列表右上方的 创建参数映射
  3. 在新打开的 创建参数映射 页面中,选择或输入相关信息:
    • 参数映射名称:必填,用于识别参数映射规则。支持中文、英文、下划线、+、-,32字符以内,以中文或字母开头。
    • 描述:选填,用于描述该参数映射的业务意义或使用范围等,64 个字符以内,可为空。
    • 映射类型:必选,用于指定该参数映射的使用场景,是 请求参数映射 还是 响应参数映射
    • 配置模板:可选,可从下拉菜单中选择已有的模板,即可在该模板的基础上进行脚本配置。
    • 脚本配置:必填,根据业务需要配置具体的参数映射模板脚本。详细的模板配置语法,参见 配置参数映射模板
      创建参数映射
  4. 确认信息无误后,点击 创建 即可。

后续操作

参数映射创建成功后,即可在后续 创建 API 或编辑 API 时,选择该映射配置实现请求或响应参数映射。