更新时间:2024-07-29 GMT+08:00
创建API分组
创建API前,需要先创建API分组。API分组相当于API的集合,API提供者以API分组为单位,管理分组内的所有API。
目前支持以下创建分组方式:
- 直接创建
创建一个简单的分组,不包含API,用户可自行创建API。
- 导入API设计文件
从本地导入已有的API文件,同步创建分组。
- 导入CCE工作负载
导入云容器引擎(Cloud Container Engine,简称CCE)工作负载,开放CCE服务能力。具体步骤请参见导入CCE工作负载。
- 对外开放API时,您需要为API分组绑定自己的独立域名。
- 一个API只能属于某一个API分组。
- API分组创建后,系统为分组自动分配一个内部测试用的调试域名,此调试域名每天最多可以访问1000次。您也可以通过关闭“调试域名开关”来关闭调试域名,关闭后将隐藏调试域名,且不能通过调试域名调用API。
- 实例创建后,有一个DEFAULT分组,可直接通过虚拟私有云地址调用默认分组中的API。
前提条件
已创建实例。
直接创建
- 进入API网关控制台页面。
- 根据实际业务在左侧导航栏上方选择实例。
- 在左侧导航栏选择“API管理 > API分组”。
- 单击“创建API分组 > 直接创建”,在弹框中填写分组信息。
表1 分组信息表 参数
说明
分组名称
API分组名称,用于将API接口进行分组管理。
描述
对分组的介绍。
- 单击“确定”,创建完成。
导入API设计文件
- 进入API网关控制台页面。
- 根据实际业务在左侧导航栏上方选择实例。
- 在左侧导航栏选择“API管理 > API分组”。
- 单击“创建API分组 > 导入API设计文件”。
- 在弹窗中选择本地路径下的API文件,然后单击“打开”导入文件。
- 填写导入信息。
表2 导入API 参数名称
说明
导入方式
导入方式包含以下2种:
- 生成新的分组:将API定义导入到一个新的分组,导入过程中系统会自动创建一个新的API分组,并将导入的API归属到该分组。
- 选择已有分组:将API定义导入到一个已有的分组,导入过程中不会删除分组中已有的API,只是将新增的API导入分组。
API分组
仅在选择“选择已有分组”时,需要选择API分组。
是否覆盖
勾选后,当导入的API名称与已有的API名称相同时,导入的API会覆盖已有的API。
仅在选择“选择已有分组”时,需要选择是否覆盖。
扩展覆盖
勾选后,当导入API扩展定义项名称(ACL,流控等)与已有的策略(ACL,流控等)名称相同时,会覆盖已有的策略(ACL,流控等)。
- (可选)单击“全局配置(可选)”。
- 单击“立即导入”,在弹窗中选择是否现在发布API到环境。
- 如果选择“现在发布”,还需要选择API要发布的环境,将API分组下的所有API发布到环境上。
- 如果选择“稍后发布”,请参考发布API。
- 单击“确定”,跳转到“API运行”页面,可查看分组下的API。
后续操作
API分组创建成功后,您可以为此分组绑定域名,API调用者通过访问独立域名来调用您开放的API。
父主题: API管理