从头开始为 API 创建流
您可以在 App Connect 中为 API 创建流 (也称为 API 流 )。 定义的配置提供了用于公开一个或多个操作的 API。 您可以使用这些操作来调用端点,并在该端点与流中的应用程序之间传递数据。
准备工作
- 如果知道需要哪些应用程序或导入的 API,可在 App Connect 应用程序和 API 页面上为针对目标应用程序或 API 运行 API 操作的连接器创建账户。 您还可以在创建流时创建帐户。 有关更多信息,请参阅 连接到帐户。
- 要使用 统一编写 来创建可在 IBM® API Connect中管理的 API 流,请确保满足以下需求。
- 您必须在同一区域拥有一个 IBM API Connect Enterprise as a Service 在同一区域中,与您的 IBM App Connect Enterprise as a Service 实例在同一区域。 如果您已经拥有 App Connect ,您可以在同一区域配置一个 API Connect 在同一地区创建试用实例。 提供一个 API Connect Enterprise as a Service 的试用实例。 App Connect 主页 ,单击管理 API 流量,使用 IBM API Connect。
- 必须使用至少一个已注册的 DataPower API Gateway 服务来配置 API Connect 实例。
- API Connect 实例必须至少包含一个您有权访问的提供者组织。 提供者组织必须包含包含具有所属使用者组织和客户机标识的应用程序的目录。
- 您必须为您的实例启用统一创作。 在 API 流程编辑器的设计器选项卡上,单击更改 API 网关设置图标 "
,启用统一创作,然后单击保存。 (如果您的 API Connect 功能,或者在与您的 webMethods 混合集成环境相同的区域内没有 API Connect Enterprise as a ServicewebMethods 的实例,则更改 API 网关设置图标将被禁用)
关于本任务
为 API 创建流时,每个单独的流都是通常从移动和 Web 应用程序调用的 API 操作的实现。 (操作示例为 "GET order" 和 "POST order"。) 每个操作的流包含一个请求,一个或多个应用程序或导入的 API 的操作以及 API 操作的响应。 该流还可能包含用于专门数据处理的工具箱节点。 该请求使用您定义的模型来请求在应用程序中创建,检索或替换数据对象。 提交请求时,每个目标应用程序或 API 都会完成其操作。 然后流会返回响应,响应确认操作成功或返回请求的数据。
- 您可以创建一个或多个模型,用于定义要创建或检索的对象的结构。 最多可以创建 10 个模型。
- 选择要针对每个模型完成的内置创建,检索或替换或更新操作,或者定义您自己的定制操作。
- 您可以配置流以实现每个操作,并为一个或多个目标应用程序或 API 添加操作。 您还可以向流添加工具箱实用程序,以处理来自这些应用程序的输入或输出数据。
如果您的 API Connect 的实例与您的 App Connect 实例在同一环境或区域,您就可以在 App Connect 和 API Connect. 此功能称为 统一编写。 默认情况下,统一编写功能被禁用。
有了统一创作,当您在 App Connect 中创建并启动 API 流程时,API 会自动添加到产品中。 然后,该产品将在目录中发布,该目录将在以下网站中提供给提供方组织 API Connect. 如果启用了 API Connect 开发人员门户网站上可见。 发布首选项基于登录的用户。 App Connect 自动发现提供商组织 API Connect 的提供商组织。 App Connect 实例。 您可以指定将 API 发布到首选 API Connect 实例和提供商组织的设置。 您还可以选择目录和网关目标,已发布 API 的包含产品和计划以及消费应用程序。
中的应用程序接口。 API Connect 中的应用程序接口 App Connect. 您还可以在 Developer Portal 中浏览产品 (和 API)。 当您在 App Connect 中停止 API 时,API 管理器用户界面和开发人员门户网站中的产品(和 API)将自动删除。 (无权访问 API Connect 的用户可以在 App Connect中停止流。 但是,该 API 仍发布在 API Connect中。)
如果您有权访问 webMethods Hybrid Integration 中的 API Connect 功能,或者有权访问与 IBM API Connect Enterprise as a Service 实例位于同一区域的 IBM App Connect Enterprise as a Service 实例,那么您可以启用统一创作。 启用统一创作后,创建并启动 API 流程时,流程会自动发布到 API Connect. 如果启动 API 流而未指定发布首选项,API 将发布到您发现的任何实例中的沙盒目录中自动生成的产品中的默认计划。 API Connect 实例的沙盒目录中自动生成的产品中发布。
您可以使用 App Connect 中的 API 编辑器来创建 API 流程,并为您的 API 定义模型和执行操作。 您还可以配置策略,网关和门户网站设置,以控制在启动流后将 API 发布到 API Connect 时的行为。 以下任务描述如何在 API Connect中创建 API 流,配置发布首选项以及访问已发布的 API。
在 App Connect 中创建 API 流
过程
要创建 API 流,请完成以下步骤。
结果
下一步操作
- 如果您使用的是 VPC hours 计划,您 可以在部署之前测试 API 的行为。 有关详细信息,请参阅测试 API(VPC 小时计划)。注: 如果启用了统一编写,并且您在为流设置发布首选项之前启动流,那么将使用为流保存的最后一组用户首选项。 如果之前没有设置首选项,API 将发布到您发现的任何实例中的沙盒目录中自动生成的产品的默认计划中。 API Connect 实例。 因此,要控制 API 的发布位置,必须确保在启动 API 之前指定首选设置。测试 API 时,API 编辑器中会出现 Test 选项卡。OpenAPI 3.0 YAML 中的运行 API 流程定义用于将 API 自动发布到指定目录和提供商组织中的产品和计划。 App Connect 中运行的 API 流的 YAML 定义用于将 API 自动发布到指定目录中的产品和计划,以及您的 API Connect 实例中的产品和计划。 如果配置了 Developer Portal ,那么 API 产品也会在其中显示。注: 如果启用了统一编写,那么将根据您的首选项将 API 添加到自动生成的产品或您选择的现有产品的独立版本。 已发布的产品仅包含您的 API。
- 当您准备好在生产环境中运行流程时,就可以进行部署。 更多信息,请参阅部署集成。
在 API Connect 中访问已发布的 API
关于本任务
过程
要在 API Connect中访问 API ,请完成以下步骤。