全部产品
云市场

API创建

更新时间:2019-12-11 23:41:04

创建API需要填写API基础信息、配置参数映射、配置转发规则。

填写基础信息

点击 新建API 按钮,弹出侧滑窗,开始填写API信息。

  • 归属应用: 每个API都需要归属在某个业务后端应用之下;
  • API名称:API名称,通常反映该API所属的业务模块、具体功能、具体接口;
  • API版本:但API需要升级时,可以保留旧版本,添加新版本,映射到后端升级后的接口,以达成前后兼容;
  • 入参请求模式
    • 入参映射:需要在API网关严格指定端上传入的每个业务参数,并选择通过名称映射到某个后端参数;
    • 入参透传:无需指定每个业务参数,所有业务参数默认保持原样透传到后端;若选择此模式,则后端协议不支持dubbo;
  • 日志模式:指定API网关是否把每个请求的日志打印到机器的指定日志文件,方便客户自行采集;具体日志路径请联系技术支持;
  • 描述:选填一段描述此API功能的信息;

填写API基础信息

配置请求

配置端上请求API的入口配置。

  • HTTPMethod:指定端上请求API可选择的HttpMethod;
  • 从模板导入:若在应用管理页配置过参数模板,可以直接导入;
  • 请求入参
    • 参数名称:端上传递业务参数的名称;
    • 参数类型:支持3种,Number,String,Boolean;
    • 参数传递:必填 和 非必填 两种。对于参数类型为必填时,请求未传参,则API网关参数校验后直接报错返回;为选填时,则端上请求可不携带,但必须设置缺省值;
    • 缺省值:若请求未携带此参数,则赋予默认值;
    • 描述:选填的描述参数作用的信息;

注意:显然,若 入参请求模式入参透传时,不需要填写参数信息,而是照原样转发。

配置请求

配置后端服务

对某个 API+版本 发起的请求,会被API网关转发到对应的后端机器上,那么,对于不同的后端服务,需要配置相关信息,以使得API网关能请求到准确的服务上。

目前服务协议类型支持 HTTP、DUBBO。

HTTP类型

注意:后端服务使用HTTP协议提供时,API所属的应用必须配置可用的机器组IP。

请求路径:HTTP请求Path;

参数映射:是指将API请求中的业务入参和协议内置参数传递到后端服务,并映射到指定的后端请求参数上。业务入参在API配置请求中定义,协议内置参数通过SDK自动携带上来。

参数类型:包含基础类型和封装类型。对于HTTP协议,参数类型支持:

  1. int
  2. long
  3. float
  4. double
  5. boolean
  6. java.lang.Long
  7. java.lang.Float
  8. java.lang.Double
  9. java.lang.Boolean
  10. java.lang.Integer
  11. java.lang.String

HTTP协议后端

DUBBO类型

注意:后端服务使用DUBBO协议提供服务时,需要联系技术支持同学,确认业务后端DUBBO服务使用的注册中心与API网关配置的注册中心保持一致。

  • 服务名(必填):指定DUBBO服务全限定名;
  • 服务分组(非必填):group_name(和DUBBO服务定义保持一致);
  • 版本(非必填):指定DUBBO服务版本;
  • 服务方法(必填):指定API接口映射到的DUBBO服务方法名;

参数映射:同HTTP协议中定义。

参数类型:包含基础类型和封装类型,对于DUBBO协议,参数类型支持:

  1. int
  2. long
  3. float
  4. double
  5. boolean
  6. java.lang.Long
  7. java.lang.Float
  8. java.lang.Double
  9. java.lang.Boolean
  10. java.lang.Integer
  11. java.lang.String

DUBBO协议后端