API网关注册

准备工作

在使用API网关注册功能前，用户需要先购买APIG实例。如果没有购买过APIG实例，可以在CodeArts API上通过以下操作步骤完成购买。

1. 单击“项目设置 > 插件管理”，进入“插件管理”页面。
2. 单击“购买运行时实例”，在弹出的填写购买实例页面，配置实例参数，具体可参照购买实例章节，完成购买。

   

约束与限制

• 对于项目中同名API的处理：如果项目中存在多个同名的API（URL、请求方式、名称相同），如果已经注册同名API到APIG实例的第一个分组中，则二次注册同名API会失败。APIG实例的同一个分组上不允许同名API重复注册。
• 删除在APIG实例中已发布的API，需要先在APIG实例中进行下线API操作，才可完成API的删除。

注册API

1. 单击“API发布 > API网关注册”进入“API网关注册”页面。

   

2. 单击“注册API”，弹出“注册API”对话框，可以选择项目中所有“已测完”或“已发布”状态的API。

   

3. 选中需要发布的API，单击“下一步”。
4. 在“选择运行时实例”的下拉框中选择需要注册的APIG实例，并配置实例参数。参数配置请参考APIG实例参数表。

   

   APIG实例参数

   参数	配置说明
   API分组	在APIG实例上已创建的API集合，创建操作可参照创建API分组章节。
   负载通道	是否使用负载通道。 选择“使用”时，需要在URL中设置使用的负载通道。如未创建负载通道时，可单击“创建负载通道”加号按钮，直接跳转“新建负载通道”页面完成创建，具体创建操作可参照负载通道章节。 选择“不使用”时，需要在URL中设置后端服务地址。
   URL	URL地址由请求协议、负载通道/后端服务地址组成。 请求协议：HTTP或HTTPS，传输重要或敏感数据时推荐使用HTTPS。 负载通道（可选） 仅在使用负载通道时，需要设置。选择已创建的负载通道名称。 后端服务地址（可选） 仅在不使用负载通道时，需要设置。

5. 单击“完成”，完成API在APIG实例中的注册。
   

   • 一个API可发布到同一个APIG的不同API分组。
   • 注册API后需要到APIG实例中完成发布API操作，才可完成API的上线。

API重新注册

CodeArts API提供API重新注册的功能，协助用户将已修改或不同版本的API重新注册到APIG实例。

1. 在“API网关注册”页面，光标移动到API版本，可查看当前API的注册信息。

   

2. 单击操作列的，弹出“重新注册API”对话框。

   

3. 选择需要重新注册的API，单击“确定”，完成API的重新注册。
   

   重新注册的API需要到APIG实例中完成发布API操作，才可完成API的上线。

API删除

1. 在“API网关注册”页面，选择需要删除的API，单击“删除”。

   

2. 弹出“删除警告”对话框，单击“确定”，完成API的删除。

   删除失败会弹出“删除失败”对话框，提示失败原因。