电脑桌面
添加蚂蚁七词文库到电脑桌面
安装后可以在桌面快捷访问

API发布者操作指南-- ②API管理

来源:金蝶云社区作者:金蝶2024-09-232

API发布者操作指南-- ②API管理

包括API的创建、修改、调试、发布、下线和删除等完整生命周期管理功能。


1 创建API

创建API操作需要定义API的基本信息、请求信息、后端服务信息、返回结果信息。创建完成的API仅为一份API定义,无法直接调用,需要使用发布功能发布至具体环境后方可调用。



1.1 配置API基本信息


  • API名称:同一区域,同一项目内不重复。

  • 所属分组:指明API所属分组,请在创建API前完成创建分组。

  • 类型:公开类型,且在RELEASE环境上发布的API可以上架订阅。

  • 安全认证:调用API时的认证方式。Appkey & Appsecret安全级别高,推荐使用。

  • 权限等级:分为普通和高级。高级接口,API调用方需先申请,待API提供者审批通过后才能使用。

  • 描述:对API进行基本描述。


1.2 定义API请求信息

API请求信息描述了API的调用者如何对当前API发起请求,包括请求方式和请求参数。



1.2.1 请求方式



  • 域名:API网关统一提供的对外访问的域名,暂不支持自定义域名。

  • 请求协议:支持HTTP和HTTPS。

  • 请求PATH: 请求path可以包含请求参数,请求参数使用:标识,例如/a/:b,也可以通过配置"*"号做前缀匹配,例如: /a/*,默认会自动加上分组路径。

  • 匹配模式:包含绝对匹配和前缀匹配。

① 绝对匹配:调用的请求Path固定为创建时填写的API请求Path。

② 前缀匹配:调用的请求Path将以创建时填写的API请求Path为前缀,支持接口定义多个不同Path。例如,请求路径为/foo/bar,使用前缀匹配时,通过/foo/bar/yy/zz可以访问,但是通过/test/baryyzz无法访问。


说明:使用前缀匹配时,匹配剩余的路径将透传到后端。例如,使用前缀匹配,前端请求路径定义为/foo/,后端请求路径定义为/foo1/,通过/foo/AA/CC访问API,则后端收到的请求url为/foo1/AA/CC。


  • 访问方式:支持GET、POST、DELETE、PUT、HEAD、PATCH、OPTIONS、ANY,ANY表示任意Method。当Method为POST、PUT、PATCH时需要配置请求Body相关内容。

  • 支持跨域: 是否开启跨域访问CORS(cross-origin resource sharing)。

CORS允许浏览器向跨域服务器,发出XMLHttpRequest请求,从而克服了AJAX只能同源使用的限制。

CORS请求分为两类:

① 简单请求:头信息之中,增加一个Origin字段。

② 非简单请求:在正式通信之前,增加一次HTTP查询请求(开启CORS后将为API添加OPTIONS method)。


1.2.2 请求参数



  • 参数名称:发起API调用时需要使用的参数名称,不可重复。

  • 参数位置:支持PATH、QUERY、HEADER。

  • 类型:支持STRING,NUMBER类型。

  • 必填:参数是否必填,设置成必填后,若实际请求时没用该参数,则请求会被拒绝。

  • 描述:参数的描述。


注意:当请求PATH中包含了PATH路径参数时,须在后端服务参数列表中也定义相同名称的后端服务参数。


1.2.3 定义后端服务信息

API后端服务信息描述了API开放者提供的服务相关信息,包括后端请求方式、后端请求参数。后端服务支持HTTP和HTTPS两种类型,需要配置不同后端请求方式。


① 配置后端服务



  • 后端名称:默认为 默认后端。

  • 请求协议:支持HTTP和HTTPS。

  • 请求方式:支持GET、POST、DELETE、PUT、HEAD、PATCH、OPTIONS、ANY,ANY表示任意Method。当Method为POST、PUT、PATCH时需要配置请求Body相关内容。

  • 后端服务类型:默认为网络地址。

  • 后端服务地址:指名后端资源所在主机的地址,支持域名、IP形式,不可重复。

  • 权重值:指名多后端地址轮询时,当前地址的权重,取值为1~100之间的整型值,默认为1。当具有多个后端地址时生效。

  • 后端分发策略:支持按次轮询和按权重轮询2种方式。

  • 请求PATH:请求path可以包含请求参数,用:标识,比如/getUserInfo/:userId,支持 *%-_. 等特殊字符。

  • 后端超时:默认5000ms。


② 配置后端请求参数


建立和请求入参的映射关系,可通过导入入参定义按钮进行批量添加,也可单独通过添加后端参数映射按钮进行添加。



  • 入参名称:选择在第一二阶段配置请求入参的参数信息。

  • 入参位置:自动填充。

  • 入参类型:自动填充。

  • 后端参数名称:后端服务需要使用的参数名称,不可重复。

  • 后端参数位置:参数位置,支持PATH,QUERY和HEADER


注意:当请求PATH中包含了

API发布者操作指南-- ②API管理

包括API的创建、修改、调试、发布、下线和删除等完整生命周期管理功能。1 创建API创建API操作需要定义API的基本信息、请求信息、后端服务...
点击下载文档文档为doc格式

声明:除非特别标注,否则均为本站原创文章,转载时请以链接形式注明文章出处。如若本站内容侵犯了原著者的合法权益,可联系本站删除。

确认删除?
回到顶部
客服QQ
  • 客服QQ点击这里给我发消息
QQ群
  • 答案:my7c点击这里加入QQ群
支持邮箱
微信
  • 微信