Collection
Collection is the first element in the workspace that needs to be created to work with an API. Collection uses to store, document and organize API calls. The collection can store different types of calls like GET, POST, PUT, DELETE and other types of calls and resources. The steps to create collection are the following
Steps to create collection
- Click on New Button
- Click on Collection
- Set the name of the collection
Figure 1.3 – Create a new Collection
Folder or sub-Folder
Folder or sub-folders are also elements of a collection which could let us to further organize our work as per our need to have our call structured and organized. This could let us to reach out to our calls easily, during the development, as well as maintaining or add existing or extra calls in our collections.
Steps to Folder or Sub-folder
- Click on three dots next to Collection
- Tap on Add Folder option.
- Set the name of the folder or subfolder.
Figure 1.4 – Folder & Sub-Folder
API calls
API calls are used to reach or ping the end point that we want to access for a different operation. The call of an API is structures in a manner having URL, Parameters, Authorization so and so forth. There are different kinds of requests, and the most common requests are GET, PUT, POST, DELETE.
Steps to Create a request
- Select the location where you want to create the collection at Collection/Folder/Sub-folder level.
- Click on Add a request.
- Set the name of the request, URL(Uniform Request Locator), method [GET.POST, PUT, DELETE] and other details of the request such as Parameters, documentation so and so forth.
Making a Request
This is a request making a process to reach to an end point. In order to perform a request all the necessary inputs has to be set correctly as per the end point that is going to be called.
Making a Request
- URL – Uniform Resource Locator
- Parameters
- Authorization
- Other details
- And then Tap on Send button.
Figure 1.5 – New Request