API列表操作

查看API管理列表

1. 在服务集成模块下选择[API工厂/API管理]，进入API管理页面。

2. 在页面顶部导航栏中选择工作空间，API管理页面显示对应工作空间下的API目录和API列表信息。

3. 在API目录中选择目录名称，页面右侧展示对应目录及其子目录下的API列表。

4. 可以根据API名称、类型、状态、标签等条件对API进行搜索。API类型目前包含三种，分别是数据API、函数API以及通用API。

• API详情：单击API名称，可以查看API详情。

• 基本属性：API的一些基本信息，例如API名称、版本号、API描述等。

• 调用信息：在调用信息页可以看到接口的请求路径、请求方式、请求参数格式、返回参数格式、请求参数和输出参数说明等。

• 请求示例：通用API和函数API可以查看请求示例，即输入参数和输出参数的JSON结构示例。

• 数据来源：数据API可以查看数据来源，包括数据源、数据库、数据模式、数据表、关联条件、sql语句（自定义sql类型）或者字段列表（字段筛选类型）。

• 服务脚本：函数API可以服务脚本，即js脚本内容。

• API上线：单击<更多>按钮，在下拉框中选择上线，可以对API进行上线。API部署后才能进行上线。

• API批量上线：勾选API前的复选框，单击API列表上方的<上线>按钮，弹出批量上线窗口，窗口对勾选的API按照可上线及不可上线进行分类展示，单击<确定上线>按钮，对可上线的API进行批量上线。API部署后才能进行上线。普通用户只能批量操作自己创建的API，不能批量操作其他用户创建的API，但是可以通过<更多>下的上线功能进行单个操作。

• API下线：当API上线后，上线按钮会变为下线。单击<更多>按钮，在下拉框中选择下线，可以对API进行下线。

• API批量下线：勾选API前的复选框，单击API列表上方的<下线>按钮，弹出批量下线窗口，窗口对勾选的API按照可下线及不可下线进行分类展示，单击<确定下线>按钮，对可下线的API进行批量下线。普通用户只能批量操作自己创建的API，不能批量操作其他用户创建的API，但是可以通过<更多>下的下线功能进行单个操作。

• 打标签：勾选API前的复选框，单击API列表上方的<打标签>按钮，在弹出框中选择标签，可为该目录下的所有API配置标签，最多选择5个标签，新选的标签会替换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信息导入到另外一套融合集成平台系统中，从而完成API资源的迁移。

1. 在服务集成模块下选择[API工厂/API管理]，进入API管理页面。

2. 在页面顶部导航栏中选择工作空间，API管理页面显示对应工作空间下的API目录和API列表信息。

3. 在API目录中选择目录名称，页面右侧展示对应目录及其子目录下的API列表。

4. 通过导出功能导出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目录信息。

5. 导入：单击<导入>按钮，弹出导入窗口。

1. 上传API资源：单击<点击上传>按钮，选择通过“导出”功能导出的API信息压缩包进行数据的导入，上传文件大小不能超过20M。

2. 导入时需选择API信息需要导入的目录，API信息会导入到该目录下。

• 如果导入的API目录树在系统中已存在则该目录树不导入。目录下的API会导入，但是API的目录会置空，用户可在导入后再根据需要重选目录。

• 目录树导入最大不能超过10层。

3. 然后单击<确定>按钮弹出导入API窗口，页面展示需要导入的API，如果包含数据API，则还展示关联的数据源信息。用户可根据需要配置各资源的导入方式（可选插入、跳过或覆盖）。

• 插入：把当前资源插入到当前工作空间下。当导入的数据源已存在时，选择“插入”，需重新设置导入的数据源名称，然后才能导入；当导入的API已存在时，选择“插入”，需重新设置导入的名称及URL路径，如果API关联的数据源未导入，则还需重新关联数据源。

• 跳过：跳过当前的资源，不进行导入。

• 覆盖：使用导入的资源覆盖当前工作空间下相同名称或相同URL的API资源。当其他工作空间下存在相同名称或相同URL的API资源时，不可选择覆盖。

6. 配置完各类型资源的导入策略后，单击<确定>按钮进行资源的导入，用户可在[工作空间]页面下单击<导入导出记录>按钮查看资源导入/导出记录，如果导入失败，则还可在此处查看失败原因。

API继承注册

继承注册功能可以帮忙用户在已有API的基础上快速进行API的注册。

1. 在服务集成模块下选择[API工厂/API管理]，进入API管理页面。

2. 在页面顶部导航栏中选择工作空间，API管理页面显示对应工作空间下的API目录和API列表信息。

3. 在API目录中选择目录名称，页面右侧展示对应目录及其子目录下的API列表。

4. 选择需要继承的API，只能选择一个API。单击<继承注册>按钮，进入API设计页面，当前新注册API完全继承了已选择API的信息，在参数配置页面，API名称必须修改为新的名称，其他属性根据实际情况修改。在参数配置页面，请求路径必须修改为新的路径，其他参数信息根据实际情况修改，修改完相关信息后保存，即可生成新的API。

API在线运维

API部署后，可以编辑API的信息（包括基本信息、参数信息等），用户可自动获取API最新的调用信息，无需再重新订阅。已经授权和订阅的工作空间，除字段筛选类型的数据API外，其他API会同步更新，调用时会自动获取最新的返回结果；字段筛选类型的数据API不会同步更新用户已订阅的字段，需要用户根据实际需要，手动去变更订阅的字段，才能拿到新的字段返回结果。

模板注册

模板注册功能支持用户通过模板创建API（暂不支持导入WebService类型的API）。

1. 在服务集成模块下选择[API工厂/API管理]，进入API管理页面。

2. 在页面顶部导航栏中选择工作空间，API管理页面显示对应工作空间下的API目录和API列表信息。

3. 在API目录中选择目录名称，页面右侧展示对应目录及其子目录下的API列表。

4. 单击<模板注册>按钮，弹出模板注册窗口，模板注册分为两个步骤：

1. 第一步为下载API模板压缩包，该压缩包包含函数API模板和通用API模板以及API模板JSON字段解析说明文档。根据说明文档了解模板中字段含义和格式，编辑通用API或函数API模板，设置API的基本信息和参数信息。

2. 第二步为上传已经编辑完成的JSON文件，单击<浏览>选择本地编辑完成的模板文件，单击<上传>完成API的导入。目前一次只能导入一条API信息。

5. 上传JSON文件后，关闭对话框，在API列表中可以查看通过模板创建的API。

API列表字段显隐

在API列表右上方，单击齿轮状图标，弹出可以控制显隐的字段列表。

1. 在服务集成模块下选择[API工厂/API管理]，进入API管理页面。

2. 在页面顶部导航栏中选择工作空间，API管理页面显示对应工作空间下的API目录和API列表信息。

3. 在API目录中选择目录名称，页面右侧展示对应目录及其子目录下的API列表。

4. 在API列表右上方，单击齿轮状图标，弹出可以控制显隐的字段列表，包括创建人、描述、版本号、更新时间、更新人等信息。

5. 可以勾选需要在列表中显示和隐藏的字段，设置完成后，该配置信息会保存下来，重新登录后，仍然沿用上次保存的风格。目前API列表字段显隐风格按照单个用户来设置，每个用户都可以设置自己的风格。