Lab 6: Implementing APIs in Anypoint Studio

Login to the Anypoint Platform and then open the Design Center.

The API editor is displayed. This API features many of the advanced features of the RAML editor that is provided by Design Center. Note the following sections that are available with this editor.

For this exercise you will use Anypoint Studio to implement and test a less complex API: the pAPI - Inquiry and Report Routing API specification. Click on the Design Center link that is to the right of the "hamburger" menu. This will take you back to the list of projects. Next, click on the pAPI - Inquiry and Report Routing API specification.

Review the various API attributes that have been defined in this specification, but do not make any changes as you will need to use it in the following steps. Take note of the following:

The intent of this step was to introduce you to the tools that are available to create API specifications. If you are interested in gaining more experience with properly authoring an API specification you are welcome to explore this topic more in depth in module 1, lab 2 of the API-led Connectivity Workshop.

Open Anypoint Exchange by clicking on the "hamburger" menu in the upper left corner of the page and then selecting Exchange.

The documentation page for the API is displayed.

If you are interested in how learning more about using Exchange you are welcome to explore this topic more in depth in module 1, lab 1 of the API-led Connectivity Workshop

If Anypoint Studio is not currently open, locate and launch the Anypoint Studio icon in your workshop desktop image.

If you have not completed Lab 3: Overview of Anypoint Studio you should complete that lab first, then return to this step.

In Lab 3 you had created a project from the Omnichannel Experience API specification in Exchange. For this lab you will create and implement the pAPI - Inquiry and Report Routing API that you had seen earlier.

Create a new project by either right-clicking in the Package Explorer or using the File→New menu options. Select the Mule Project menu item.

Name your project papi-inquiry-and-report-routing and then click on the green + icon to select and import the desired API specification from Exchange.

Ensure you are logged in by verifying the Username field has your userid in it. Login if necessary.

Ensure that the most current version of the module is selected and then click on the Finish button.

Click on the Finish button to start the scaffolding process.

Scroll the main editor window to the bottom to observe that the two HTTP methods that were defined in the API specification have been created with placeholders. These are labeled:

A primary requirement of this "Process" API is to interact with two "System" APIs to either GET or POST information. Since these System APIs are cataloged in Anypoint Exchange, you can download "connectors" to these APIs to make calling this APIs much simpler.

Enter sapi in the search window, add the sAPI - Medical Inquiry System System API to the Add Dependencies to Project dialog box, and then click on the Finish button.

Now you will repeat these steps to add another System API. Enter sapi in the search window, add the sAPI - AE Safety Report System System APIs to the Add Dependencies to Project dialog box, and then click on the Finish button.

You should now see that connectors for both System APIs have been added to the Mule Palette.

Click on each of the System APIs to view a dashboard of details regarding the API. Capture the Domain value for each System API.

Return to Anypoint Studio and click on the Global Elements tab at the bottom of the flow editor.

You will need to create a Connector Configuration for each of the System APIs. Click on the Create button, expand the Connector Configuration section, select the desired System API and then click on the OK button.

Now that the connection properties have been saved you can double-click on the connector configuration and use the Test Connection…​ button to ensure that you have entered proper values.

Once you have created connector configurations for both System APIs you can edit the flows to meet your requirements. Click on the Message Flow tab at the bottom of the main editor to continue.

Implementing the functions of your API implementation is mostly a matter of dragging and dropping various message processors from the Mule Palette and setting properties for each processor. In the Mule Palette click on the Core category to access the pre-provisioned processors that are available.

In the Message Flow editor scroll to the bottom where you will find the get:\request:papi-inquiry-and-report-routing-config flow. Click on the the Transform Message processor and delete it using the Delete key or by right clicking on it and using the Delete menu option. Next, expand the Core category of components, then drag and drop the Choice processor from the Flow Control cateogry onto the flow.

The Choice processor enables you to control which set of actions you want to process, based on the value you set in the Expression property. For this API, you will want to invoke the GET method on either the Medical Inquiry System API or the AE Safety Report API, depending on the query parameter passed to the API.

%dw 2.0
output application/java
---
attributes.queryParams.requestType=="Medical Inquiry"

You will need to add the appropriate methods to submit GET requests for each of the System APIs.

Start with the Medical Inquiry System connector. Click on the connector in the Mule Palette, then drag and drop the Get inquiries operation into the When branch. The property editor should appear. Select the Medical_Inquiry_System_API_Config connector configuration, click on the fx button, then copy and paste the following expression into the Expression field.

attributes.queryParams.requestId

Next, click on the AE Safety Reports connector, then drag and drop the Get adverse events operation into the Default branch. The property editor should change to reflect the Get adverse events processor. Select the AE_Safety_Reports_API_Config connector configuration, click on the fx button, then copy and paste the following expression into the Expression field.

attributes.queryParams.requestId

Your final task for this method is to transform the messages that have been returned from the System APIs into a JSON payload. Click on the Favorites category in the Mule Palette, then drag and drop the Transform Message operation into the flow, to the right of the Choice processor. Set the Output expression to the following:

%dw 2.0
output application/json
---
payload

Now, turn your attention to the post:\request:application\json:papi-inquiry-and-report-routing-config method. You will need to perform a similar set of tasks that you did for the get:\request:papi-inquiry-and-report-routing-config method.

%dw 2.0 output application/java
---
payload.requestType=="Medical Inquiry"

Click on the Medical Inquiry System connector in the Mule Palette, then drag and drop the Create inquiry operation into the When branch. The property editor should appear. Ensure that payload is set in the Create inquiry request data field.

Next, click on the AE Safety Reports connector, then drag and drop the Get adverse events operation into the Default branch. The property editor should change to reflect the Create adverse event processor. Ensure that payload is set in the Create adverse event data field.

Save your flow.

Check the Problems tab in the lower portion of the Studio and correct any problems that may appear.

Double click on the Google Chrome icon on the desktop.

Click on the Set as default button.

Click on the Internet Explorer link found under the Web Browser item, then select Google Chrome.

Close the Default apps dialog.

You are now ready to begin testing your API. Right click in the main editor and then select the Debug project papi-inquiry-and-report-routing menu item.

During the startup phase of the test you may see several messages appear in the Console tab, and will ultimately be presented with a Confirm Perspective Switch dialog. Click on the Yes button to proceed.

The layout of the Studio will change to accomodate testing and debugging of your application. Before you begin to test your application you should review the Console tab to ensure that your application has started successfully.

Anypoint Studio includes APIkit, which is an API testing tool. Click on the APIkit Consoles tab, then click on the Open console button to launch the testing tool. The tool will open in a new browser window.

The API console will display the resources and methods that have been scaffolded in your API. Note that although this testing tool is running in your local Studio instance, it will still invoke the System APIs that you have configured in your application.

Click on the GET method. Note that the requestType and requestId query parameters have test values already assigned to them. These test values came from the API specification when it was developed. Review the contents of the test console, then click on the Send button to execute a test.

Note the response message that was returned for the Medical Inquiry request. This is the response message that was returned from the sapi-med-inquires System API.

Change the requestType value to Adverse Event and then click on the Send button. You should see a response with adverse event data.

Your next test is to try submitting "medical inquiry" and "adverse event report" messages via the POST method.

{
  "requestType": "Medical Inquiry",
  "requestDetails": {
    "mir": {
      "inquiryId": "90414",
      "description": "Vaccine and Heart Drug Interactions",
      "details": "Is there any information to date regarding drug interactions with the H1N1 vaccine? ",
      "contactName": "Dr. James Richards",
      "contactEmail": "jr@jhopkins.edu",
      "contactPhone": "555-123-4567",
      "contactOrg": "Johns Hopkins",
      "contactDate": "2020/10/29"
    }
  }
}

The last test to execute is to submit an "adverse event report". Copy and past the following JSON message into the Body of the APIkit Console and then click on the Send button. You should receive a response message stating Received - Pending Submission.

{
  "requestType": "Adverse Event Report",
  "requestDetails": {
    "ae": {
      "identifier": {
        "system": "http://acme.com/ids/patients/risks",
        "value": "49476534"
      },
      "actuality": "actual",
      "category": [
        {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/adverse-event-category",
              "code": "product-use-error",
              "display": "Product Use Error"
            }
          ]
        }
      ],
      "event": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "304386008",
            "display": "O/E - itchy rash"
          }
        ],
        "text": "This was a mild rash on the left forearm"
      },
      "subject": {
        "reference": "Patient/example"
      },
      "date": "2017-01-29T12:34:56+00:00",
      "seriousness": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/adverse-event-seriousness",
            "code": "Non-serious",
            "display": "Non-serious"
          }
        ]
      },
      "severity": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/adverse-event-severity",
            "code": "mild",
            "display": "Mild"
          }
        ]
      },
      "recorder": {
        "reference": "Practitioner/example"
      },
      "suspectEntity": [
        {
          "instance": {
            "reference": "Medication/example"
          }
        }
      ]
    }
  }
}

At this point you have successfully tested out your API implementation. From this point your dev/ops team would configured their CI/CD pipeline to automatically promote and deploy this API to the runtime environment. If you would like more information on configuring DevOps for your MuleSoft applications please click on the following link to download the following MuleSoft whitepaper: APIs and DevOps - Great alone, better together