When you’re testing endpoints with different parameters, you can use one of the many GUI REST clients available to make the requests. You can also use curl (which we’ll cover soon), but GUI clients tend to simplify testing with REST APIs.
With a GUI REST client, you can:
Using a GUI REST client, you won’t have to worry about getting curl syntax right and analyzing requests and responses from the command line.
Some popular GUI clients include the following:
Of the various GUI clients available, Postman is probably the best option, since it allows you to save both calls and responses, is free, works on both Mac and PC, and is easy to configure.
A lot of times abstract concepts don’t make sense until you can contextualize them with some kind of action. In this course, I’m following more of an act-first-then-understand type of methodology. After you do an activity, we’ll explore the concepts in more depth. So if it seems like I’m glossing over concepts things now, like what a GET method is or a endpoint, hang in there. When we deep dive into these points later, things will be a lot clearer.
In this exercise, you’ll make a REST call for the second endpoint (
https://simple-weather.p.mashape.com/weather) in the Mashape Weather API.
You can also call the first endpoint (
aqi), but the response is pretty short (2 characters), and unfortunately sometimes the API doesn’t always return a response for the location. If this endpoint isn’t working, you’ll see “Not supported” response.
Click the Params button (to the right of the box where you inserted the endpoint) and insert
lng parameters with specific values (other than
Only some countries are supported in this weather API — specifically the United States, Singapore, Malaysia, Europe, and Australia. If the country isn’t supported, you’ll see “Not supported” in the API response. The latitude and longitude coordinates for Santa Clara, California are
lat: 37.3710062 and
lng: -122.0375935. For Singapore, they’re
lat: 1.3321256 and
lng: 103.7373503. You can find latitude and longitude values from the URL in Google Maps when you go to a specific location. The latitude appears first.
When you add these
lng parameters, they will dynamically be added as a query string to the endpoint URI. For example, your endpoint should now look like this:
https://simple-weather.p.mashape.com/weather?lat=37.3710062&lng=-122.0375935. Query string parameters appear after the question mark
? symbol and are separated ampersands
&. The order of query string parameters doesn’t matter.
Click the Headers tab (below the GET button) and insert the key value pairs:
Accept: text/plain and
X-Mashape-Key: APIKEY. (Swap in your own API key in place of
APIKEY. If you want to use my API keys, see apikeys.txt.)
Your inputs should look like this:
The response appears, such as
15 c, Mostly Cloudy at Sunnyvale, United States. In this case, the response is text only. You can switch the format to HTML, JSON, XML, or other formats, but since this response is text only, you won’t see any difference. Usually the responses are JSON, which allows you to select a specific part of the response to work with.
If you get a response that says “Unsupported,” this means your
lng values aren’t supported. Use the
lng values shown here (
Saved endpoints appear in the left side pane under Collections.
Enter details into Postman for the
weatherdata endpoint for the Mashape Weather API:
The Accept header tells the browser what format you will accept the response in. Whereas the first two endpoints (
text/plain, the Accept header for the
weatherdata endpoint is
When you save these other endpoints, click the arrow next to Save and choose Save As. Then choose your collection and request name. (Otherwise you’ll overwrite the settings of the existing request.)
(Alternatively, click the + button on the new tab and create each request in separate tabs.)
While the first two endpoint responses include text only, the weatherdata endpoint response is in JSON.
In Postman, make a request to the weatherdata API. Then toggle the options to Pretty and JSON.
The Pretty JSON view expands the JSON response into more readable code.
To “prettify” code means to un-minify it and format it with white space that is readable.
For the sake of variety with GUI clients, here’s the same call made in Paw:
Like Postman, Paw also allows you to easily see the request headers, response headers, URL parameters, and other data. However, Paw is specific to Mac only.
Now let’s switch APIs a bit and see some weather information from the Aeris API. Constructing the endpoints for the Aeris Weather API is a bit more complicated since there are many different queries, filters, and other parameters you can use to configure the endpoint.
Here are a few requests to configure for Aeris. You can just paste the requests directly into the URL request box in Postman and the parameters will auto-populate in the parameter fields.
Note that the Aeris API doesn’t use a Header field to pass the API keys — the key and secret are passed directly in the request URL as part of the query string.
When you make the following requests, insert your own values for the
Get the weather forecast for your area:
In the response, find the wind speed and compare it with the wind from the Mashape API. Are they the same?
Get the weather from a city on the equator — Chimborazo, Ecuador:
Find out if all the country music in Knoxville, Tennessee is giving people migraines:
You’re thinking of moving to Arizona, but you want to find a place that’s cool. Use the
You can also make these requests by simply going to the URL in your address bar. Use the JSON Formatter plugin for Chrome to automatically format the JSON response.
By looking at these two different weather APIs, you can see some differences in the way the information is called and returned. However, fundamentally both APIs have endpoints that you can configure with parameters. When you make requests with the endpoints, you get responses that contain information, often in JSON format. This is the core of how REST APIs work — you send a request and get a response.
11/93 pages complete. Only 82 more pages to go...
If you would like to contribute back to say thank you for the API documentation course, click the Donate button below. Alternatively, to contribute content, such as a tutorial or a new section, contact me with your ideas. You can also submit a pull request in the GitHub repo to make your contribution. Even if you want to just fix a typo or add a sentence here and there, it's always welcome.
Get new posts delivered straight to your inbox.
© 2017, Tom Johnson