Skip to content

Develop an Integration with Integration Studio

Choreo simplifies the process of building, deploying, and managing integration components, making it easy to expose integrations as APIs. This guide walks you through the steps to expose an integration created in WSO2 Integration Studio as an API in Choreo.

In this guide, you will: - Create a component to expose a sample integration from the Choreo samples repository as an API. - Deploy, test, and observe the integration component. - Publish the integration component as an API to the Choreo Developer Portal.

Note

  • To develop integrations for Manual Task and Schedule Task components in Choreo, use the automation mode in the WSO2 Micro Integrator. See Running MI in Automation Mode.
  • For other component types (Service, webhook, event-handler, etc.), use the server mode.

Prerequisites

  1. If you're signing in to the Choreo Console for the first time, create an organization:

    • Go to https://console.choreo.dev/ and sign in.
    • Enter a unique organization name. For example, Stark Industries.
    • Read and accept the privacy policy and terms of use.
    • Click Create. This creates the organization and opens the Project Home page.

  2. Fork the Choreo samples repository, which contains the sample integration for this guide.

Step 1: Create the integration component

  1. Go to https://console.choreo.dev/ and sign in. This opens the Project Home page.

  2. If you already have one or more components in your project, click + Create. Otherwise, proceed to the next step.

  3. Click the Service card.

  4. Provide a unique name and description for the component:

    Field Value
    Component Name Hello World
    Description Hello World REST API

  5. Connect to GitHub:

  6. Go to the GitHub tab.

  7. Click Authorize with GitHub to connect your GitHub account. If you haven't connected your GitHub repository to Choreo, enter your GitHub credentials and select the repository you forked in the prerequisites section to install the Choreo GitHub App.

    Note

    The Choreo GitHub App requires the following permissions: - Read and write access to code and pull requests. - Read access to issues and metadata.

    You can revoke access if needed. Write access is only used for sending pull requests; Choreo will not push changes directly to your repository.

  8. Enter the following repository details:

    Field Description
    Organization Your GitHub account
    Repository choreo-samples
    Branch main
    Buildpack WSO2 MI (since you're creating the REST API from a WSO2 Integration Studio project)
    Project Directory hello-world-mi

  9. Click Create. Choreo initializes the component with the sample integration.

Step 2: Deploy the integration component

  1. In the Choreo Console left navigation menu, click Deploy.

  2. Configure and deploy:

  3. In the Build Area card, click Configure & Deploy.
  4. In the Configurations pane, click Next. This displays the endpoint details ready for deployment.

  5. Click Deploy. This deploys the integration component to the development environment.

    Tip

    • Choreo uses endpoints to expose Service components to the network. Learn more about configuring endpoints in Configure Endpoints.
    • Automatic deployment is enabled by default, so only the first deployment needs to be done manually.

The Development card shows the Deployment Status as Active when the integration is successfully deployed.

Step 3: Test the integration

  1. In the Choreo Console left navigation menu, click Test and then click Console.
  2. In the OpenAPI Console, select Development from the environment drop-down list.
  3. Expand the GET /integration operation.
  4. Click Try it out, then click Execute. This sends a request to your deployed integration.

  5. Check the response:

    • In the Response body section, observe the response. If the integration works as expected, you should see:
    {"Hello" : "Integration"}

Step 4: Observe the integration

  1. Click Observability in the left navigation menu to monitor the performance of the integration component.

  2. View metrics:

  3. Observe throughput and latencies of requests over time.
  4. View logs generated during a specific period.
  5. Analyze the flame graph (Diagnostics View) for performance insights.

For more details, see Observability Overview.

Step 5: Publish the integration component

  1. In the Choreo Console left navigation menu, click Manage and then click Lifecycle.
  2. The Lifecycle Management pane shows the current lifecycle stage as Created.
  3. Click Publish. This changes the lifecycle stage to Published and exposes the integration as an API in the Choreo Developer Portal.
  4. To view the published API, click Go to Devportal. In the Developer Portal, you can manage subscriptions and generate access tokens for testing.

Now you have successfully exposed an integration designed in WSO2 Integration Studio as a REST API in Choreo!