发布API分组

API分组信息创建完成后,需要通过发布才能使用。目前京东云提供了3套发布环境:测试、预发、线上。您可以在测试、预发环境中发布和测试API分组,并下载SDK和文档;在线上环境中正式发布上线 API分组的SDK和文档。

在发布完成后,API调用者可通过自定义域名或二级域名,访问调用API。

注意:

  • 如果发布时选择的Mock后端,则调试时不会请求真实后端服务,而会直接返回常量结果。这种方式适用于调试 API 的请求链路是否正确,会跳过鉴权 和 签名校验 环节;

  • 如果选择的唯一后端并录入后端地址后,则网关会真实地请求该后端服务。

操作步骤

STEP1:选择要进行发布的分组

首先,进入 API分组管理页,并找到要发布的分组

STEP2:点击操作中的 发布:

在“API分组管理”页面,点击 创建分组 ,进入“新建API分组”页面。 说明:

1)选择要发布的版本。API网关支持分组的版本管理功能,因此在发布时,注意选择您需要发布的版本。后续还可在环境管理中切换或者下线不同的版本。

2)选择要发布的环境。API网关提供了三种环境:测试、预发、线上。

3)您还未配置测试环境中的API分组默认后端,请完成配置后再进行发布。

4) 如果发布测试环境,自动通过无需审核

5) 如果发布正式环境或正式环境切换版本时,需要虎符运营审核,接口中不能包含敏感信息,审核通过后才可完成发布,审核周期为1~3个工作日

提交上线申请后以邮件的形式通知虎符运营审核:
邮箱: jcloud-yd@jd.com
邮件标题: 虎符自定义场景API分组上线申请
邮件内容:

  • 开发者PIN(登录京东云鼎的PIN)
  • API分组id
  • 要发布的API分组版本号
  • 业务场景/申请原因
  • 接口字段描述/包含哪些字段,是否包含敏感字段
  • 公司名称
  • 申请人
  • 联系电话
  • 联系邮件(用于接收审核结果信息, 请务必填写)

注: 审核周期为1~3个工作日

STEP3:在部署管理中,管理各个环境下发布的版本:

发布完成后,可在部署管理页中,看到各个环境的部署情况。

API 网关支持对测试/线上的 API 做版本管理,您可以发布 API、下线 API 还可以切换版本,切换版本是实时生效。

STEP4:下线

如需下线,可直接点击下线操作。实时生效。

results matching ""

    No results matching ""