Skip to main content

API导出与跨项目导入

导入导出功能一般用于API的跨项目复制,例如业务上将API的环境区分了开发项目和生产项目,两者之间网络隔离,无法通过一键发布的方式完成跨项目的复制,此时可以在开发项目中先将已经开发完成的API打包导出至本地,再通过人工或传输工具导入到生产项目的方式完成复制。

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

导出API

API市场中可选择一个或多个API导出成zip包。

可支持导出的API类型:生成API、注册API、服务编排(选择服务编排时其包含的Python函数也将一起导出)和服务分组。

当前用户对哪些API可导出:有调用权限的API。

img

选中的API将形成一个「发布包」,需填写发布包名称、描述。点击「确定」,会自动以zip格式文件包下载。zip包内包含内容:每个API的JSON文件(内含该API的所有信息)及API的所属租户和描述信息。

导入API

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

进入API导入界面,点击导入API按钮,选择要导入的API包(仅支持zip格式)后上传。

img

img

选择zip包点击上传后,API的导入将走以下流程:

image-20230216153011929

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发生更新,这里的发布包不会更新。若需导出最近版本的API,请前往「API市场」中进行批量导出。

导出