文档首页/ API网关 APIG/ 用户指南/ 开放API/ 发布APIG创建的API
更新时间:2024-11-27 GMT+08:00

发布APIG创建的API

创建完成的API,支持发布到不同的环境。API只有在发布到环境后,才支持被调用。API网关支持查看API发布历史(如版本、发布说明、发布时间和发布环境),并支持回滚到不同的API历史版本。

  • 已发布的API,在修改信息后,需要重新发布才能将修改后的信息同步到环境中。
  • 同一个API在每个环境中最多记录10条最新的发布历史。

前提条件

已创建环境。

发布API

  1. 进入API网关控制台页面。
  2. 根据实际业务在左侧导航栏上方选择实例。
  1. 在左侧导航栏选择“API管理 > API分组”。
  2. 单击分组名称
  3. 在“API运行”页面,选择待发布的API,单击“发布最新版本”。
  4. 选择API需要发布到的环境,并填写发布说明。

    • 如果API在选择的环境中已发布,再次发布即为覆盖该环境的API。
    • 如果在选择的环境时没有自己需要的环境,可以创建一个自己需要的环境。

  5. 单击“确定”,API发布成功后,“发布最新版本”按钮左上角的红色感叹号消失。

    已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户后,选择待下线的API,单击“下线”即可。

查看发布历史

  1. 在“API运行”页面,选择待查看发布历史的API。
  2. 单击“更多 > 发布历史”。
  3. 在版本所在行,单击“查看版本”,弹出此版本详细信息对话框。

    查看API基本信息、API请求、后端请求、入参定义、参数映射、常量参数和返回结果。

  4. 如果想要设置之前版本为当前版本,则在版本所在行,单击“切换至此版本”,弹出“切换至此版本”对话框。

    单击“确定”,完成版本的切换。此时版本号旁边显示“当前版本”,说明设置成功。

    API调用者调用此API时,API参数为“当前版本”设置的参数,不是最后一次编辑保存的API参数。

    例如,2018年8月1日发布在RELEASE环境的API匹配模式设置为“绝对匹配”,2018年8月20日修改API匹配模式设置为“前缀匹配”,并发布到RELEASE环境。然后设置2018年8月1日发布的版本为当前版本,此时API调用者调用此API时,API的匹配模式为“绝对匹配”。

后续操作

API发布完成后,您或API调用者就可以调用API了。如果您提供的是APP认证方式的API,还需要配置API调用授权(可选)才可调用API。