The document discusses the API Notebook within the MuleSoft Anypoint Platform, designed to enhance API discoverability and usability. It provides details on how to create and use the API Notebook for testing APIs, including generating API clients and invoking API flows through code cells. The aim is to facilitate user interaction with APIs by allowing personalized testing and exploration of API resources and methods.

1. API NOTEBOOK
By:- Rakesh Kumar Jha
MuleSoft Certified Architect, Designer and Developer
DZone MVB (Most Valuable Blogger)
Websites:-
https://dzone.com/users/2959749/rakeshjha.html
https://linkedin.com/in/rakesh-kumar-jha-660a57103

2. API Discovery and API Notebook
A well designed API has to be discoverable. MuleSoft anypoint platform API portal
provides a centralized place for discovering all the tools (API Documentation, Mock API
testing etc) that anybody can use to successfully discover an API.
MuleSoft anypoint platform API portal provides API Notebook, a web-based tool to
explore the API in JavaScript scripting workspace. API Notebook generates API client
from API RAML specification to understand API’s resources, methods, required
arguments etc and allow user to make live call to API for personalized testing.

3. Creating API Notebook
In the API Portal we can create API Notebook as shown below.

4. The very first section in API Notebook we just created is called “APIClient”. Here
Notebook automatically created the API client to understand API RAML specification
(defined in API Manager) as discussed in 2nd slide. Lets save the Notebook now.

5. Invoking API Flow From Notebook
Now let’s invoke an API flow for personalized testing. We first have to insert a code cell
to write flow specific logic to make an API call. We can create a code cell as below.

6. Invoking API Flow From Notebook
In the new code cell created, We can see all the API resource as an object of API client
named “client” which we just created.
API Resources:- APIClientName.ResourcesName
example:- client.customerDetails, client.customer.ID(‘1234’) etc
API Resource Methods:- APIClientName.ResourcesName.HTTPMethod
Example:- client.customerDetails.post, client.customer.ID(‘1234’).get
And then we can pass API resource body and required Query Parameters and Header
Parameters.

7. The complete code cell will look like below after setting API resource, method, query and
header parameters and body(if applicable like for POST method) looks like below.

8. Now since our code cell is ready, we can execute the code cell to make an API flow call
and see the result. Please follow the below screens.

10. Let’s Share our Knowledge to Expand our MuleSoft Community.
Thank You!!