API导入导出

API导出

用户可在“API市场”和“API管理-导入API”两个页面中实现API导出。用户可先在测试环境中进行API调试,无误后在API市场批量导出API,再在正式环境中导入API,提高效率。

API市场中的导出功能

API市场支持单个导出和批量导出。

步骤一:选择API

单个导出:点击单个API右侧的“导出”按钮。
批量导出:勾选多个API后点击左下角的“批量导出”按钮,可支持在某一页中选择多个API批量导出,不支持跨页的批量导出。

批量导出
服务编排暂时不支持导出。

步骤二:生成zip文件包

在点击导出或者批量导出后,要求填写API包的名称和描述,填写完毕后点击确定,会自动以zip格式文件包下载。

zip文件夹包

“API管理-导入API”中的导出功能

支持包中所有的API以zip文件夹的方式导出,导出时仍为最初导入时API的版本。若需导出最近版本的API,请前往“API市场”中进行批量导出。

导出

API导入

数据服务支持将外部已经配置好的一个或多个API以zip格式文件包的形式导入,API导入的使用流程如下:

步骤一:进入API导入界面。

API导入

步骤二:点击导入API按钮,选择要导入的API包(仅支持zip格式),服务编排暂时不支持导入。

导入成功

API类目处理规则

API包中带有类目信息,系统将自动判断包中API对应的类目信息在本项目中是否存在。

  • 如果存在,系统将API放入已存在的类目。

  • 如果不存在,系统将自动创建对应类目。

  • 用户可点击“API管理”中的“类目管理”查看API当前的类目地址。

API名称处理规则

API包中一般具有多个API,系统将自动判断包中API名称在本项目中是否存在。

  • 若项目中存在已经发布的同名API:

    • 当新导入的API处于发布成功状态时,API市场的同名API才会被覆盖。

    • 当新导入的API处于非发布成功状态时,API市场的同名API仍可正常使用。

  • 若项目中存在未发布的同名API,系统会将已经存在的同名API删除,将新API放至API包中解析得到的类目下。

  • 若不存在,系统将自动创建对应API。

步骤三:API包的查看、导出、提交、发布
导出、提交、发布是针对包中所有API执行,不能对单个API执行。

  • 若需了解提交、发布的具体意义,可前往API发布与提交

  • 包中所有API提交/发布成功,才计该API包提交/发布成功,操作失败可点击“查看-查看日志”了解错误原因。

如需对单个API进行操作,可前往API管理界面进行搜索。