There are thousands of public REST APIs available on the internet that you can use to build web applications, desktop applications, command-line tools, etc. Despite their numbers, finding a suitable API for your app can become tedious if you search the web to find the right one. But with RapidAPI Hub, you can do all this in under a few minutes.
RapidAPI Hub is home to over 35000+ APIs of 45 different categories. If you don’t have an account, you would first have to sign up on the website to use the APIs. Afterward, a unique API Key will be generated for you. With this API key, you will have access to all APIs.
In this piece, we will look at all the different sections you encounter when you open an API page on RapidAPI Hub. So without any further ado, let’s jump in!
Make sure you have signed up and logged in to your RapidAPI account. Otherwise, you will not be able to subscribe to any API. Once it’s done, choose any API you like. For the sake of this piece, I am going with the Famous Quotes API. Go ahead and subscribe to it.
As you can see, the page is divided into six sections:
Top Info: Here, the name of the API is present along with other details.
Navigation: Here, you can switch between different screens related to the API.
Description: This section contains the description of the API.
Endpoints list: This area lists down all the API endpoints available to the user.
Request: This section contains different options that you need to set to use the API.
Response: You can use this area to copy code snippets for calling the API, check the example response (if there is any), and look at the results the API call has brought with it.
Let’s take a deeper look at each of these six sections.
This part of the page holds the basic information related to the API like its name, author name, when it was last updated, what category it lies into, etc. You can also see the API's popularity, latency, and service level stats. These stats help you decide whether you should go with this API or look for another one on the RapidAPI Hub.
This page area contains a navigation bar to see different pages related to the API.
This is the default page that you see. It contains three sections. The leftmost section contains the list of endpoints, the middle section adds different options and makes the API request, and the rightmost section shows the API response, among other things.
This tab includes a more detailed description of the API.
This tab contains step-by-step instructions on how to use the API. The page will be empty if the author has not written down the instructions.
You can discuss stuff related to the API on this tab of the API page.
This tab of the page contains different price packages related to the API. You can subscribe to the package you like from here.
This section contains a brief description of the API, what it does, what you can do with it, etc.
On the main page, inside the
Endpoints tab, look at the left-most section. It contains a list of all the endpoints you can use with the given API. When you click on the endpoint, it will change the code snippet in the right-most section.
This is the middle section of the API page. Here, you can set different options like setting the query parameter, changing the header values, etc.
This section contains three tabs, i.e.,
Code Snippets where you can generate different code snippets to call the API,
Example Response which shows how the response of a particular endpoint will look like, and the
Results to show the response of the API request.
That’s pretty much it. I hope now you understand the user interface of the API page of RapidAPI Hub.