1. I'd Rather Be Writing
2. Docs
3. Chapter 2: Using an API like a developer

Scenario for using a weather API

Download PDF

Let’s start using an actual REST API to get more familiar with how they work. In the upcoming sections, you’ll explore some weather APIs in the context of a specific use case: retrieving a weather forecast. By first playing the role of a developer using an API, you’ll gain a greater understanding of how your audience will use APIs, the type of information they’ll need, and what they might do with the information.

• Sample scenario: How windy is it?
• Get an idea of the end goal
• Activity: Explore the OpenWeatherMap API
• Explore the Aeris Weather API
• More weather APIs

Sample scenario: How windy is it?

Let’s say that you’re a web developer and you want to add weather information to your site. Your site is for cyclists. You want to allow users who come to your site to see the current wind and temperature conditions. You want something like this:

You don’t have your own meteorological service, so you’ll need to make some calls out to a weather service to get this information. Then you will present that information to users.

Get an idea of the end goal

To give you an idea of the end goal, here’s a sample: idratherbewriting.com/assets/files/wind-openweathermap.html. It’s not necessarily styled the same as the mockup, but it answers the question, “What’s the current wind and temperature?”

Click the Check wind conditions button to see wind and temperature details. When you request this data, a call is made to the OpenWeatherMap API. The API retrieves the information, and some JavaScript code prints the information on the page.

The above example is extremely simple. You could also build an attractive interface like this:

The concept and general techniques are more or less the same. Behind the scenes, the code makes requests to a weather service API and then displays the returned information in a stylized user interface.

Activity: Explore the OpenWeatherMap API

Although there are many good weather API options for developers, I decided to use the OpenWeatherMap API in this course because the service is easy to use, free, and stable.

Let’s explore the basic sections in the OpenWeatherMap API:

1. Go to the openweathermap.org.
2. Click API in the top navigation bar.
3. In the Current weather data section, click the API doc button.

4. Click some of the links in the Examples of API calls sections.

   Get a sense of the information this Current Weather Data API provides. The API calls provide developers with ways to pull information into their applications. In other words, the APIs will provide the data plumbing for the applications that developers build.

5. Answer the following questions about the Current Weather Data API endpoint:

   • Does the API provide the information we need about temperature, wind speed, wind direction, and current conditions?
   • How many different ways can you specify the location for the weather information?
   • What does a sample request look like?
   • How many endpoints does the API have?
   • What authorization credentials are required to get a response?

Explore the Aeris Weather API

Before diving too far down in the OpenWeatherMap API, let’s look at another weather API for contrast. In contrast to the OpenWeatherMap API, the Aeris Weather API is a bit more robust and extensive. Explore the Aeris Weather API by doing the following:

1. Go to www.aerisweather.com.
2. Click Documentation on the top navigation bar. Then click API Documentation.

3. In the left sidebar, under Reference, click Endpoints. Select the All tab to show all endpoints, and then scroll down a bit and click observations.

   

4. Browse the type of information that is available through this endpoint. Does this endpoint provide information about wind and temperature that would work for our sample development scenario?

Here’s the Aeris weather forecast API in action making mostly the same calls as I showed earlier with OpenWeatherMap: idratherbewriting.com/assets/files/wind-aeris.html. (Note: If this returns [Object][Object], it’s because my API key expired. You can view the page source to see how the call is constructed.)

For our development scenario (showing weather on a website), there are dozens of different weather APIs we could use. As you create your API documentation, think about how your users might have to make the same decisions in choosing APIs. Are there several APIs that provide similar information? What will make your API stand out more? Although you probably can’t pick and choose what information your API returns, you might at least argue that the docs for your API will be superior!

More weather APIs

About Tom Johnson

I'm an API technical writer based in the Seattle area. On this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, AI, information architecture, content strategy, writing processes, plain language, tech comm careers, and more. Check out my API documentation course if you're looking for more info about documenting APIs. Or see my posts on AI and AI course section for more on the latest in AI and tech comm.

If you're a technical writer and want to keep on top of the latest trends in the tech comm, be sure to subscribe to email updates below. You can also learn more about me or contact me. Finally, note that the opinions I express on my blog are my own points of view, not that of my employer.