搜索
支持控制台（Console）开发人员开始试用联系人

此内容没有您所选择的语言版本。

Chapter 5. Implementing the AMQ to REST API sample integration

download PDF

This sample integration connects to a Red Hat AMQ broker to obtain item delivery records for a hypothetical enterprise. The integration then executes a custom step that operates on the records to identify any items that were damaged when they were received. After a simple data mapping, the integration connects to a REST API to obtain contact information for vendors of damaged items.

The other sample integrations use connectors and data operations that are built into Fuse Online. This integration also does that, but in addition, it provides instructions for customizing and extending Fuse Online by leading you through the procedures for:

  • Adding a custom data operation by uploading an extension.
  • Adding a custom REST API client connector by uploading an OpenAPI (Swagger) document.

Fuse Online provides the extension file and the OpenAPI document.

Prerequisite

To implement the AMQ to REST API sample integration, the main steps are:

  1. Section 5.1, “Creating an AMQ connection”
  2. Section 5.2, “Making a custom step available”
  3. Section 5.3, “Creating a REST API connector”
  4. Section 5.4, “Uploading the To Do app icon”
  5. Section 5.5, “Creating a REST API connection”
  6. Section 5.6, “Creating and deploying the AMQ to REST API sample integration”
  7. Section 5.7, “Confirming that the AMQ to REST API integration works”
  8. Section 5.8, “Cleaning up your integration”

5.1. Creating an AMQ connection

The AMQ to REST API sample integration starts by connecting to an AMQ broker (Red Hat AMQ) that is provided in your OpenShift Online project. Before you start to create the integration itself, you must start the broker and create a connection to that broker.

Procedure

  1. Start the broker:

    1. In a browser, go to the OpenShift Online Web Console. Your Fuse Online environment runs on OpenShift Online.

    2. In the console, on the right, under My Projects, click Fuse Online to display the project’s overview.

      Your project’s name is something like proj123456.

    3. In the overview, click the > to the left of the first entry, broker-amq, #1, to expand the entry for the provided Red Hat AMQ broker.
    4. On the right, click the up caret to scale up to running 1 pod. This starts the AMQ broker.

  2. Create the AMQ connection:

    1. In Fuse Online, in the left panel, click Connections to display any available connections.
    2. In the upper right, click Create Connection to display Fuse Online connectors.
    3. Click the Red Hat AMQ connector.

    4. Configure the connection by entering:

      1. In the Broker URL field, enter tcp://broker-amq-tcp:61616 as the location to obtain data from.
      2. In the Username field, enter amq as the user name for the account that accesses this AMQ broker.
      3. In the Password field, enter topSecret as the password for the account that accesses this AMQ broker.
      4. Leave the other fields blank.
    5. Click Validate. Fuse Online immediately tries to validate the connection and displays a message that indicates whether validation is successful. If validation fails, check the values you entered and try again.
    6. When validation is successful, in the upper right, click Next.
    7. In the Connection Name field, enter your choice of a name that helps you distinguish this connection from any other connections. For example, enter Red Hat AMQ Broker 1.
    8. In the Description field, optionally enter any information that is helpful to know about this connection. For example, enter Connection to the provided Red Hat AMQ message broker.
    9. In the upper right, click Create to see that the connection you created is now available. If you entered the example name, you would see that Red Hat AMQ Broker 1 is now available.

5.2. Making a custom step available

Fuse Online provides a number of steps that operate on integration data between connections. If Fuse Online does not provide a between-connections step that meets your need, a developer can code an extension that defines one or more custom steps that operate on data between connections. The developer gives you a .jar file that contains the extension. You then upload the extension in Fuse Online to make the custom step(s) available for use in integrations.

The AMQ to REST API sample integration uses a custom step that operates on data between connections to identify items that were damaged when they were received.

Procedure

  1. In a new browser tab, go to https://github.com/syndesisio/fuse-online-sample-extension/releases.
  2. Download the extension’s .jar file.
  3. In Fuse Online, in the left panel, click Customizations.
  4. At the top, click Extensions.
  5. Click Import Extension.
  6. Click Choose File and select the downloaded .jar file that contains the extension. Fuse Online validates the file, extracts and displays the extension’s ID, name, description, and type, and lists Damage Reporter as the custom step that the extension defines.
  7. Click Import Extension. Fuse Online makes the custom step available and displays the list of extensions that have been imported.

Additional resources

For information about coding an extension and creating its .jar file, see:

5.3. Creating a REST API connector

Fuse Online can create connectors for REST APIs that support Hypertext Transfer Protocol (HTTP)/1.0 or HTTP/1.1. To do this, Fuse Online requires a valid OpenAPI 2.0 document that describes a REST API that you want to connect to.

Your Fuse Online environment provides the To Do app, which has a REST API for accessing a database that contains tasks. Your environment also provides an OpenAPI (Swagger) document for this API.

Procedure

  1. Identify the URL for your Fuse Online environment’s copy of the OpenAPI document:

    1. In the Fuse Online navigation panel, click Home.
    2. Copy the URL into a text editor.
    3. At the beginning of the URL, insert todo-.
    4. At the end of the URL, remove dashboard if it is present.
    5. At the end of the URL, add swagger.json.

    6. Use the http scheme instead of https.

      The result is something like this: http://todo-app-proj217402.6a63.fuse-ignite.openshiftapps.com/swagger.json

    Note

    Specification of http rather than https avoids a runtime error if TLS certificates are not valid. In production environments, ensure that valid certificates are in place, and always specify secure URLs (https) to obtain an OpenAPI document.

  2. In the Fuse Online navigation panel, click Customizations.
  3. Click Create API Connector.
  4. Select Use a URL.
  5. In the input box, paste the URL for your OpenAPI document and click Next.
  6. On the Review Actions page, click Next. If you see a warning, you can ignore it.
  7. Click Next again to accept HTTP Basic Authorization.

  8. On the Review/Edit Connector Details page, Fuse Online populates the fields with values from the OpenAPI document.

    1. If you want to, you can change the values in the Connector Name and Description fields.
    2. Confirm that the value in the Host field is correct. For example, it should be something like this: https://todo-app-proj217402.6a63.fuse-ignite.openshiftapps.com.
    3. Confirm that the value in the Base URL field is /api.

  9. Click Create API Connector.

    Fuse Online displays the API Client Connectors tab with an entry for the Todo App API that you just created.

5.4. Uploading the To Do app icon

To show the flow of an integration, Fuse Online displays icons that identify the applications that the integration is connecting to. Your Fuse Online environment provides an icon for the To Do app. Follow these instructions to upload it.

Procedure

  1. Display the To Do app icon:

    1. In a new browser tab, paste the URL for your OpenAPI document.
    2. At the end of the URL, replace swagger.json with images/todo_icon.png and click Enter to display the icon. For example: https://todo-app-proj217402.6a63.fuse-ignite.openshiftapps.com/images/todo_icon.png.
  2. Save the todo_icon.png image.
  3. In Fuse Online, in the API Client Connectors tab, click the entry for the Todo App API to display its details.
  4. On the Connector Details page, below the Base URL field, click Edit.
  5. Next to the default connector icon, click Choose File.
  6. Navigate to todo_icon.png, select it, and click Open. The icon appears near the top of the connector details page.
  7. Below the Base URL field, click Save.

5.5. Creating a REST API connection

In an integration, before you can connect to a REST API, you create a REST API client connector and then use that connector to create a connection. You already created a REST API connector for the To Do app. Follow the instructions here to use that connector to create a connection to the To Do app REST API.

Prerequisite

  • You created the Todo App REST API connector.

Procedure

  1. In Fuse Online, in the left panel, click Connections to display any available connections.
  2. In the upper right, click Create Connection to display available connectors.
  3. Click the Todo App API connector that you just created.
  4. In the Todo App API Configuration, notice that Fuse Online populates the Authentication Type, Base Path, and Host fields from the connector information.
  5. In the Username field, enter any value. For this sample integration, user name and password values are required but they are not used.
  6. In the Password field, enter any value.
  7. Click Next.
  8. In the Connection Name field, enter your choice of a name that helps you distinguish this connection from any other connections. For example, enter Todo App API Client.
  9. In the Description field, optionally enter any information that is helpful to know about this connection. For example, enter Connection to the provided Todo app REST API.
  10. In the upper right, click Create to see that the connection you created is now available.

5.6. Creating and deploying the AMQ to REST API sample integration

To create and deploy the AMQ to REST API sample integration, the main steps are:

  1. Section 5.6.1, “Choosing the start connection”
  2. Section 5.6.2, “Choosing the finish connection”
  3. Section 5.6.3, “Adding a damage reporter step”
  4. Section 5.6.4, “Adding a data mapping step”
  5. Section 5.6.5, “Giving the integration a name and deploying it”

Prerequisites

  • You created a connection to the provided Red Hat AMQ broker.
  • You created an API Client connection to the provided Todo app.
  • You uploaded the extension that provides the Damage Reporter step.

5.6.1. Choosing the start connection

In Fuse Online, to create the sample AMQ to REST API sample integration, the first task is to choose the start connection.

Prerequisites

  • You started the provided Red Hat AMQ broker.
  • You created a connection to that message broker.

Procedure

  1. In Fuse Online, on the left, click Integrations.
  2. Click Create Integration.
  3. On the Choose a Start Connection page, click your AMQ connection. If you specified the example name, you would click Red Hat AMQ Broker 1.
  4. On the Choose an Action page, click the Subscribe for messages action to receive messages from the queue you specify.
  5. In the Destination Name field, enter inventoryReceived for the name of the queue to obtain data from.
  6. Click in the Destination Type field and select Queue.
  7. Leave the other fields blank.
  8. Click Next. Fuse Online prompts you to specify the output data type. This is not needed for this sample integration.
  9. Click Done to add the start connection to the integration.

Next step

When the integration is running, after connecting to Red Hat AMQ, the integration watches for messages on the inventoryReceived queue. When a message is available, the integration passes it to the Damage Reporter step. However, before you can add that step to the integration, you must choose the integration’s finish connection.

5.6.2. Choosing the finish connection

In Fuse Online, to continue creating the AMQ to REST API sample integration, after you add the start connection, you add the finish connection to the integration.

Prerequisites

  • You uploaded the provided OpenAPI document to create the Todo App API connector.
  • You used the Todo App API connector to create a Todo App API connection.

Procedure

  1. In Fuse Online, on the Choose a Finish Connection page, click the To Do app connection that you created. If you assigned the example name, you would click Todo App API Client.
  2. On the Choose an Action page, click Create new task, which provides information about who to contact to address a particular damaged item.

5.6.3. Adding a damage reporter step

With the start and finish connections in place, you are ready to add the custom step that receives the messages from the Red Hat AMQ broker and identifies any items that were damaged when they were received.

Prerequisite

  • You uploaded the extension that provides the Damage Reporter custom step.
  • You added the start and finish connections to the integration.

Procedure

  1. In Fuse Online, in the visualization panel on the left, click the plus sign.
  2. On the Choose a Step page, click Damage Reporter.

5.6.4. Adding a data mapping step

To continue creating the AMQ to REST API sample integration, you need to add a data mapping step. This step correlates the task field in the output from the damage reporter step to the task field in the database that the REST API accesses.

Prerequisite

  • You added the Damage Reporter step to the integration.

Procedure

  1. In Fuse Online, in the visualization panel on the left panel, click the plus sign that is between the Damage Reporter step and the finish connection.
  2. On the Choose a Step page, click Data Mapper. In the data mapper, the Source panel on the left displays the fields in the output from the damage reporter step. The Target panel on the right displays the fields in the database that the API accesses.
  3. In the Source panel, click the task field.
  4. In the Target panel, expand the body field and click task.
  5. In the upper right, click Done.

Result

The integration is complete and it is ready to be published. On the left, in the integration visualization panel, you might see a warning Data Type Mismatch warning icon. You can ignore it.

5.6.5. Giving the integration a name and deploying it

The AMQ to REST API sample integration is complete when it has a Red Hat AMQ start connection, a Damage Reporter step, a data mapper step, and it finishes with a Todo App Client API connection. Follow the instructions here to deploy it.

Prerequisites

  • You added the start and finish connections to the integration.
  • You added a Damager Reporter step between the start and finish connections.
  • You added a data mapper step between the Damage Reporter step and the connection to the Todo App API.

Procedure

  1. In Fuse Online, in the upper right, click Publish.
  2. In the Integration Name field, enter a name for the integration. For example, AMQ to REST API Sample Integration.
  3. Optionally, in the Description field, enter information that might be helpful to know about this integration.

  4. In the upper right corner, click Publish.

    Fuse Online starts to deploy the integration and then displays the list of integrations in this environment. In the entry for your AMQ to REST API integration, you can see a progress indicator that shows the publishing stages. Fuse Online is generating the runtime for the integration and will start it when the runtime is ready. This takes a few minutes.

    A Fuse Online account is limited to a specific number of integrations that can be running at one time. For details, see the pricing plan. If you are already running the maximum number of integrations, then you must stop an integration before you can start running another one.

    If you are using a Fuse Online evaluation account, then only one integration at a time can be running. If you already created one of the other sample integrations and that integration is running then this integration is automatically in the Stopped state. You must stop the running integration and then you can then publish this integration.

  5. If you are already running the maximum number of integrations, follow these steps to stop an integration:

    1. In the left panel, click Integrations.
    2. In the entry for the integration that you want to stop, click ThreeVerticalDotsKebab on the far right.
    3. In the popup, click Stop.

  6. After stopping an integration, start another integration as follows:

    1. In the left panel, click Integrations.
    2. In the entry for the integration that you want to start, click ThreeVerticalDotsKebab on the far right.
    3. In the popup, click Publish.

5.7. Confirming that the AMQ to REST API integration works

After you create and publish the AMQ to REST API sample integration, you can confirm that it works as defined.

Prerequisite

In Fuse Online, in the list of integrations, Running appears next to the AMQ to REST API integration that you created and deployed.

Procedure

  1. In a new browser window, go to the To Do app display by inserting todo- in front of the URL for your Fuse Online environment. For example: https://todo-app-proj761432.6a63.fuse-ignite.openshiftapps.com/.
  2. In the To Do app display, click Show JMS Form to display an input box that contains an XML message.

  3. Click Send JMS Message to send that message to the Red Hat AMQ broker in your OpenShift project.

    Successful execution returns a task from the To Do app client API. The task identifies the ID of the damaged item and the contact information for its vendor. If the task does not appear in a moment or two, try reloading the page.

  4. Edit the XML message to specify two damaged items:

    1. Click Show JMS Form to display the message input box again.
    2. In the XML message, change the entry for the undamaged item to specify damaged="true".
    3. Click Send JMS Message. The To Do app client API returns a new task that contains IDs for two damaged items and contact information for the two vendors.

  5. Edit the XML message to specify an ID that you make up:

    1. Click Show JMS Form.
    2. In the XML message, for the item that has damaged="true", change the item ID, for example, to 1234.
    3. Click Send JMS Message. The To Do app client API returns a new task with the item ID that you just entered.

  6. Optionally, view the integration log to troubleshoot an unexpected result or to learn more about integration execution:

    1. In Fuse Online, in the left panel, click Integrations.
    2. Click the entry for your AMQ to REST API integration.
    3. In the integration’s summary page, click the Activity tab.
    4. Click the integration execution for which you want to view activity information.

5.8. Cleaning up your integration

When you are done working with a sample integration, you should stop it and delete it so that you can use the resources for another integration.

Prerequisites

  • You are finished working with a sample integration that you published.

Procedure

  1. In Fuse Online, in the left panel, click Integrations.
  2. In the main panel, identify the entry for the sample integration that you want to stop.
  3. In that entry, to the right, click Kebab Menu and then click Stop.
  4. Click Stop to confirm that you want to stop running the integration.
  5. In the entry for the integration that you just stopped, to the right, click Kebab Menu and then click Delete.
  6. Click Delete to confirm that you want to delete the integration.
Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务，以及可以信赖的内容，帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情，请参阅红帽博客.

關於紅帽

我们提供强化的解决方案，使企业能够更轻松地跨平台和环境（从核心数据中心到网络边缘）工作。

© 2024 Red Hat, Inc.