MuleSoft Anypoint Exchange

Out-of-the-box discovery of APIs and their metadata

Introduction

The LeanIX VSM MuleSoft Anypoint Exchange integration offers the automated out-of-the-box creation and updating of LeanIX API Fact Sheets. In this way, we provide API information that can be linked to Software Artifacts to understand which APIs a Software Artifact exposes. The integration also provides an API portfolio view that allows everyone in the organization to find the right APIs and know what services are providing them. VSM is focused on the high-level information of APIs

Integrate with MuleSoft Anypoint Exchange to:

  • build a unified API catalog
  • augment your Software Artifacts with APIs they provide to understand the impacts of architectural changes

In the first version of the MuleSoft Anypoint integration we only support API specs (see below). In a later version, we will also support Data Types as defined in the API Specification Fragments of MuleSoft Anypoint Exchange.

Setup

The MuleSoft Anypoint Integration works with the LeanIX Integration Hub to scan your company data, process it into an LDIF and automatically trigger the Inbound Integration API processor.

The LeanIX integration only connects with MuleSoft Anypoint Exchange - not any other MuleSoft product.

📘

Activating the integration

Please reach out to your CSE/M to have the integration activated in your workspace.

Installation

This integration doesn't require any installation of a plugin-in, as the Integration Hub handles the entire integration.

Configuration

  1. In your VSM workspace go to 'Administration > Integration Hub'
  2. Create a new data source by clicking on 'New Data source'
  3. Enter the following details:
    1. Connector Name: 'vsm-mulesoft-anypoint-connector'
    2. Data source name: any name to identify the data source.
  4. Enter the following attributes in the connector template:
    1. orgName: The name of the organization whose API assets are to be scanned in MuleSoft Anypoint Exchange.

      Please refer to the FAQs for more details

    2. password: Your MuleSoft Anypoint login password
    3. username: Your MuleSoft Anypoint login username
{
    "connectorConfiguration": {
        "orgName": "LeanIX"
    },
    "secretsConfiguration": {
        "password": "********",
        "username": "LeanIX"
    },
    "bindingKey": {
        "connectorType": "leanix-vsm-connector",
        "connectorId": "leanix-mulesoft-anypoint-connector",
        "connectorVersion": "1.0.0",
        "processingDirection": "inbound",
        "processingMode": "full",
        "lxVersion": "1.0.0"
    }
}
  1. Click "Run" to start the integration.

📘

Sync Logging

Open "Sync Logging" tab to get understand the progress of your current integration run. Sync Logging also provides information on previous integration runs

Scheduling your integration

The connector runs on a daily schedule by default. You can set a different schedule for the integration to run on if needed. Following steps are required:

  1. In the connector configuration window click on 'Schedule'and select from the below options:
schedule optionsschedule options

schedule options

  1. The connector JSON should now contain an attribute 'scheduling' and look similar to:
{
    "connectorConfiguration": {
        "orgName": "LeanIX"
    },
    "secretsConfiguration": {
        "password": "********",
        "username": "********"
    },
    "bindingKey": {
        "connectorType": "leanix-vsm-connector",
        "connectorId": "leanix-mulesoft-anypoint-connector",
        "connectorVersion": "1.0.0",
        "processingDirection": "inbound",
        "processingMode": "full",
        "lxVersion": "1.0.0"
    },
    "scheduling": {
        "active": false,
        "cronPattern": "0 0 23 * * *"
    }
}

Imported Data

Below you find how objects fetched from Mulesoft are translated into LeanIX Factsheets and attributes on them.

Mulesoft Anypoint Object

LeanIX Value Stream Management

API Assets from Anypoint Exchange

API Fact Sheet

API Asset Type

"API Type" Tag on the API Fact Sheet
The following are the API types identified:

  • 'rest-api' / 'http-api'
  • 'soap-api'

API Asset "Published on" date

Lifecycle start date for the state "active"

API Asset "status" change to "deprecated"

Lifecycle start date for the state "Phase out"

API Asset "Published by"

Subscription for "Responsible" person

API Asset "Contact name"

Subscription for "Responsible" person

API URL in Anypoint Exchange

Link available on API Fact Sheet as a resource

Tag on API Fact Sheets: MuleSoft Anypoint

Mapping discovered APIs to Software Artifacts

Our integration will automatically discover all APIs you have in MuleSoft and create API Fact Sheets (as detailed above). Currently, information stored in MuleSoft does not allow LeanIX to connect the API Fact Sheets to Software Artifacts (e.g. Microservices) automatically. To leverage a semi-automatic mapping mechanism follow the steps below:

  1. Retrieve & Copy the 'MuleSoft Asset ID' on a given API Fact Sheet - this is the unique ID for this Fact Sheet
  1. In the to-be-linked Software Artifact Fact Sheet paste the Mulesoft Asset ID from 1) into the field API ID
  1. Run the connector in a one-off run as per Configuration to instantly link the factsheets. As part of your scheduled connector run, the processors will attempt to match API & SW Artifact Fact Sheets automatically.

Removing API Fact Sheets

If APIs or certain versions of APIs are deleted from your organization in MuleSoft Anypoint, they are not automatically removed from your LeanIX workspace. That means the relevant Fact Sheets are therefore retained. This behavior prevents errors.
In order to remove fact sheets in LeanIX from APIs that no longer exist in MuleSoft Anypoint, these must be deleted manually.

Customisations

Integration also supports Integration API execution groups via Integration Hub to enable users to add custom processors. To process the data correctly, you need to add a custom processor set.

Sample data source configuration with execution groupSample data source configuration with execution group

Sample data source configuration with execution group

Unique execution group name for the integration is vsmMulesoftAnypointInbound

The integration API will pick up your processors and merge them with the base processors at execution time. Make sure to set the Integration API run number accordingly.

For more information on the execution groups visit: https://docs.leanix.net/docs/integration-api#section-grouped-execution-of-multiple-integration-api-configurations

FAQs

Where do I find my MuleSoft Anypoint Exchange Organization Name?

  1. Go to Mulesoft Anypoint Plattform
  2. Find all your available Organizations listed

🚧

Spaces in the Organization Name

If you copy the name of the organization from the Mulesoft Anypoint user interface, please make sure that no spaces that do not belong to the name are copied.


Did this page help you?