Exercise 2: Build a MuleSoft App

In this exercise, you’ll build a hotel-reservation API in Anypoint Code Builder, enrich it with Topic Center metadata, validate it with governance rulesets, publish it to Exchange, scaffold the implementation, and deploy it to CloudHub.

Step 1: Launch Anypoint Code Builder

1. Log into your Anypoint account at anypoint.mulesoft.com.

2. Click on the Navigation Toggle to open the Sidebar.

3. Click on Anypoint Code Builder.

   TIP

   You can also use Desktop IDE by downloading VSCode Studio. Refer documentation for more information.

4. Click Terms and Conditions.

5. Read the full Terms and Conditions, set I accept the Anypoint Code Builder beta Terms and Conditions. to True, and click Get Access.

6. Click Launch to open Anypoint Code Builder.

TIP

It could take a few minutes to build and open your virtual environment.

Step 2: Create a Topic-Enabled API

1. Select Design an API under Quick Actions.

2. Configure the API as follows:

   Field	Value
   Enable this API for Agent Topic and Actions	True
   Project Name	coral-cloud-reservation
   Project Location	default
   API Type	default
   API Specification	OAS 2.0 (YAML)
   Business Group	Leave blank

3. Click Create Project.

4. Set Trust the authors… to True and click Yes, I trust the authors.

5. Click on your Profile Icon and select Sign in with Anypoint Platform…

6. If prompted Do you want code-server to open the external website?, click Open.

7. Back in Anypoint Code Builder, select your available Business Group.

   TIP

   You should be automatically logged in, however, if prompted to sign in, use your credentials from Exercise 1.

8. Replace the placeholder in coral-cloud-reservations.yaml with the following API Design Specification:

   openapi: 3.0.0
   info:
     version: 1.0.0
     title: Hotel Reservations API
     description: API to manage hotel room bookings, check availability, and apply loyalty benefits.
   x-sfdc:
     agent:
       topic:
         name: Hotel_Room_Reservation
         classificationDescription: This API allows agents to book, modify, and cancel hotel reservations, as well as apply loyalty upgrades.
         scope: Your job is to assist customers in booking hotel rooms based on their preferences, loyalty status, and availability. You should also be able to recommend upgrades if the customer qualifies.
         instructions:
           - Always check the customer's loyalty status before finalizing the booking.
           - If the customer asks to create a reservation, check for a check-in date, checkout date, roomType, or any special requests.
           - If the preferred room type is unavailable, suggest alternative options with similar amenities.
           - Never confirm a reservation without validating payment information.
           - If the customer qualifies for an upgrade, apply it automatically and notify them.
   paths:
     /reservations:
       post:
         summary: Create a new hotel reservation
         description: Book a hotel room with specified preferences and apply loyalty upgrades if eligible.
         operationId: reservationCreate
         x-sfdc:
           agent:
             action:
               publishAsAgentAction: true
         parameters:
           - in: query
             name: source
             required: false
             schema:
               type: string
             description: Source of the reservation request (e.g., web, mobile app, agent).
             x-sfdc:
               agent:
                 action:
                   isUserInput: true
         requestBody:
           required: true
           description: Customer reservation details including stay dates, room type, and special requests.
           content:
             application/json:
               schema:
                 additionalProperties: false
                 type: object
                 x-sfdc:
                   agent:
                     action:
                       isUserInput: true
                 properties:
                   customerId:
                     type: string
                     description: Unique identifier of the customer making the reservation.
                   checkInDate:
                     type: string
                     description: Date of check-in for the reservation.
                   checkOutDate:
                     type: string
                     description: Date of check-out for the reservation.
                   roomType:
                     type: string
                     description: Preferred room type for the reservation.
                   specialRequests:
                     type: string
                     description: Additional requests like pillow type or air freshener choice.
         responses:
           "201":
             description: Reservation successfully created.
             content:
               application/json:
                 schema:
                   additionalProperties: false
                   type: object
                   x-sfdc:
                     agent:
                       action:
                         isDisplayable: true
                     privacy:
                       isPii: true
                   properties:
                     reservationId:
                       type: string
                       description: Unique identifier of the created reservation.
                     upgradeApplied:
                       type: boolean
                       description: Indicates whether a loyalty-based upgrade was applied.
                     totalPrice:
                       type: number
                       description: Final price after applying any discounts or upgrades.
   
     /reservations/{reservationID}:
       get:
         summary: Retrieve reservation details
         description: Get details of a specific reservation by ID.
         operationId: reservationRetrieve
         x-sfdc:
           agent:
             action:
               publishAsAgentAction: true
         parameters:
           - in: path
             name: reservationID
             required: true
             schema:
               type: string
             description: Unique identifier of the reservation to be retrieved.
             x-sfdc:
               agent:
                 action:
                   isUserInput: true
         responses:
           "200":
             description: Reservation details retrieved successfully.
             content:
               application/json:
                 schema:
                   additionalProperties: false
                   x-sfdc:
                     agent:
                       action:
                         isDisplayable: true
                     privacy:
                       isPii: true
                   type: object
                   properties:
                     reservationId:
                       type: string
                       description: Unique identifier of the reservation.
                     customerId:
                       type: string
                       description: Unique identifier of the customer who booked the reservation.
                     roomType:
                       type: string
                       description: Type of room booked for the reservation.
                     checkInDate:
                       type: string
                       description: Check-in date of the reservation.
                     checkOutDate:
                       type: string
                       description: Check-out date of the reservation.
                     upgradeApplied:
                       type: boolean
                       description: Indicates whether a loyalty-based upgrade was applied.

9. Save the file (CMD+S on Mac or CTRL+S on PC).

10. Review the topic generated by the YAML and click Apply.

Step 3: Run Governance Rulesets

1. In the Sidebar, open Governance Rulesets.

2. Run SF API Topic & Action Enablement Ruleset and verify readiness.

   

3. If configured correctly, the output will read:

No conformance issues found after running validations with selected rules or rulesets.

Step 4: Publish Your API to Exchange

1. In Anypoint Code Builder, open the command palette (CMD+SHIFT+P on Mac or CTRL+SHIFT+P on PC).

2. Search for Publish API and click MuleSoft: Publish API Project to Exchange.

   

3. In the Publish API Project to Exchange dialog, keep defaults and click Publish.

4. Set both Asset Version and API Version to 1.0.0, then click Publish.

5. When prompted to implement coral-cloud-reservation, select Yes.

6. Set the Project Name to coralcloud-hotel-reservation-impl.

7. Leave Target Folder blank and press OK.

8. Accept the latest Java Version and Version by pressing return.

Step 5: Building the Mule Application

1. You will be taken to the new project CORALCLOUD-HOTEL-RESERVATION-IMPL.

2. Open coralcloud-hotel-reservation-impl.xml inside src/main/mule/.

   

3. Open the Flow List.

4. Select the get:/reservations flow.

   

5. Click the + under the Logger element to add a new connector.

6. Search for Transform with output JSON and add it.

7. In the Transform Message element, paste this DataWeave script into Inline Script:

   %dw 2.0
   output application/json
   ---
   {
     reservationId: vars.reservationID,
     customerId: "CUST001",
     roomType: "Suite",
     checkInDate: "2025-03-28",
     checkOutDate: "2025-04-02",
     upgradeApplied: true,
     specialRequests: "Ocean view, foam pillows"
   }

   

Step 6: Creating an API Instance

1. Open a new browser tab and go to Anypoint Platform.

2. In the Sidebar, open API Manager.

3. Click Add API → Add new API.

4. Set Runtime to Mule Gateway.

   TIP

   You can also use Flex Gateway and Managed Flex Gateway for the APIs that are hosted externally.

5. Leave Proxy type and Mule version default. Click Next.

6. Select coralcloud-hotel-reservation.

7. Leave defaults and click Next.

8. Leave Instance label blank and click Next.

9. Leave Upstream URL blank and click Next.

10. Review and click Save.

11. Note your API Instance ID for later.

Step 7: Adding Auto-Discovery

1. Return to Anypoint Code Builder.

2. Open coralcloud-hotel-reservation-impl.xml in src/main/mule/.

3. Below </http:listener-config>, add:

   <api-gateway:autodiscovery apiId="<API_INSTANCE_ID>" ignoreBasePath="true" doc:name="API Autodiscovery" doc:id="22e21554-387e-44c3-9f08-3863b610633c" flowRef="<MAIN_FLOW_NAME>" />

   

4. Replace <API_INSTANCE_ID> with your ID from the previous step and replace <MAIN_FLOW_NAME> with your main flow name. You can find the flow name under the Flow List.

   

5. Save the file (CMD+S or CTRL+S).

Step 8: Deploy MuleSoft App to CloudHub

1. With coral-cloud-reservation.xml open, click the Rocket icon.
2. Select CloudHub 2.0.
3. Choose Cloudhub-US-East-2 – Shared Space.
4. Select Sandbox.
5. Pick the latest Java Runtime.
6. Set Asset Version to 1.0.0.
7. Click Open in Runtime Manager.

Step 9: Configure Your API Secrets

1. In a new tab, go to Anypoint Platform → Access Management → Business Groups.

2. Select your Business Group and copy the Client ID and Client Secret.

3. Return to the Runtime Manager tab.

4. Click coralcloud-hotel-reservation-impl.

5. Open the Properties tab and add:

   Key	Value
   anypoint.platform.client_id	Your Client ID
   anypoint.platform.client_secret	Your Client Secret

   

6. Click Apply Changes.

7. Copy the Public Endpoint.

Step 10: Update API Instance

1. In API Manager, open the coral-cloud-reservation API.
2. Click Edit.
3. Update both Consumer Endpoint and Upstream URL to your Public Endpoint, appending /api/.
4. Click Save and confirm status is Active.

Summary

In this exercise, you:

1. Launched Anypoint Code Builder and accepted the beta terms
2. Created and published a topic-enabled API to Exchange
3. Built and deployed a Mule application with auto-discovery
4. Configured runtime secrets for secure platform access
5. Updated your API instance in API Manager

With your MuleSoft app live in CloudHub and integrated into API Manager, you’re now ready to sync it into Salesforce’s API Catalog and activate agent actions in the next exercise.