Lab 3: Overview of Anypoint Design Center

If you are not logged into the Anypoint Platform, open your web browser and navigate to https://anypoint.mulesoft.com.

Enter your credentials into the Username and Password fields.

You should see the Anypoint Platform landing page once logged in.

Click on the button labeled Start designing, or click on the hamburger menu, and click on Design Center.

You should see the Design Center landing page, which lists all APIs someone within your organization or business group has already designed or is in the process of designing.

Click on the + Create new button and select the New API Specification option.

In the New API Specification popup window:

You should see the following API Summary page once the project is created.

On the API Summary page:

Review the right panel, and notice the RAML and OAS tabs. In fact, this panel renders the API specifications using RAML or OAS, depending on the tab you select at the bottom. You probably already noticed that API Designer updates it in real-time as you enter information.

Next, click the + to the right of RESOURCES to add a new resource.

For this new resource:

Now, click on the Body tab, and then the Add Body button. Naturally, the body represents the request message expected by the Post method.

Accept the default value for Media Type, select Object for Type, and click on the details icon.

Click on the Edit tab right of the Example text box, and paste the following JSON example into the Example text box.

 {
  "orderNumber": "569230458",
  "orderDate": "2022-08-11T07:57:59",
  "customerId": "4467337563",
  "invoiceAddress": {
    "street1": "38 Hudson Plaza",
    "street2": "Suite 203",
    "city": "Corpus Christi",
    "stateCode": "TX",
    "countryCode": "US",
    "postalCode": "78405",
    "contactId": "240697754",
    "emailAddress": "arothwell0@ed.gov",
    "phoneNumber": "+1.361.892.0758"
  },
  "deliveryAddress": {
    "street1": "89730 Oxford Lane",
    "street2": "Building A",
    "city": "Garland",
    "stateCode": "TX",
    "countryCode": "US",
    "postalCode": "75049",
    "contactId": "871254970",
    "emailAddress": "wmcgloughlin1@ifeng.com",
    "phoneNumber": "+1.214.250.6260"
  },
  "orderLines": [
    {
      "lineNumber": "1",
      "sku": "MU00-0509-BLK",
      "quantity": "3"
    },
    {
      "lineNumber": "2",
      "sku": "MU00-0698-NVY",
      "quantity": "2"
    }
  ]
}

Next, click on the Responses tab, and then the Add New Response button.

Select 201 - Created tab from the Status drop down list.

Click on the Add Body button. Naturally, the body, in this case, represents the response message returned by the Post method when the status is 201 (i.e., resource created successfully).

Now:

Now, switch to the text editor by clicking on the Edit RAML button.

On the popup window:

The text editor is divided into three primary panels.

Now, notice the four collapse and expand buttons.

Next, notice the second button from the top left.

Finally, notice the second button from the top right.

Expends the editor shelf if it is collapsed.

Enter a new line below the Title element, and make sure your cursor is in column 1.

Click on the description element in the editor shelf and enter any description for this API.

Hover your mouse pointer over any RAML element, mediaType in the following screen capture, and notice the tooltip, which describes the element.

Click on the Exchange Dependencies button in the left pannel.

Next, click the + to the right of Fragments to include an existing fragment in your project.

You should see a list of all RAML fragments available in Anypoint Exchange. This list is filtered based on your privileges, organization, and business group.

Enter Order Instance Example in the search bar.

Check the box left of the Order Instance Example fragment, and click on the Add 1 dependency button.

Your project now includes the current version of this RAML fragment as a dependency.

Click on the Files button in the left pannel.

Now, you will replace the example you copied in a previous step with this RAML fragment. First, select the block per the following screen capture - i.e., from the strict element to the type element, but excluding it.

Then, delete the block.

Now position your cursor one space to the right of the example: element and type an exclamation mark (!).

Click on the include element in the editor shelf.

Next, expend exchange_modules and click on the three vertical dots right of order-instance-example.raml.

Then, select the option Copy path from the context menu.

In the text editor, position your cursor to the right of the example: !include element, right click your mouse, and select the option Paste from the context

You replaced the hard coded example with a RAML fragment.

Resuming from the previous step, click on the POST button in the right Documentation panel.

Optionally, expend the right panel. Regardless, the right panel displays the mocking service for the Post method of the Order resource, including the example payload you included in the specification.

Click on the Try it button to simulate the Post method of the Order resource.

Click on the Send button.

Scroll down and notice the 201 status code and example payload you defined in your API specification.