Next phase of course
Congratulations, you finished the documenting REST APIs section of the course. You’ve learned the core of documenting REST APIs. We haven’t covered publishing tools or strategies. Instead, this part of the course has focused on the creating content, which should always be the first consideration.
- Summary of what you learned
- More practice with API requests and responses
- The next part of the course
Summary of what you learned
During this part of the course, you learned the core tasks involved in documenting REST APIs. First, as a developer, you did the following:
- How to make calls to an API using curl and Postman
- How to pass parameters to API calls
- How to inspect the objects in the JSON payload
- How to use dot notation to access the JSON values you want
- How to integrate the information into your site
Then you switched perspectives and approached APIs from a technical writer’s point of view. As a technical writer, you documented each of the main components of a REST API:
- Resource description
- Request example
- Response example
- Code example
- Status codes
Although the technology landscape is broad, and there are many different technology platforms, languages, and code bases, most REST APIs have these same sections in common.
More practice with API requests and responses
If you’d like to get more practice making requests to APIs and doing something with the response (even just printing it to the page), check out the additional tutorials in the Resources section:
- Overview for exploring other REST APIs
- EventBrite example: Get event information
- Flickr example: Retrieve a Flickr gallery
- Klout example: Retrieve Klout influencers
- Aeris Weather Example: Get wind speed
The next part of the course
Now that you’ve got the content down, the next step is to focus on publishing strategies for API documentation. This is the focus of the next part of the course.
42/96 pages complete. Only 54 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.
I'd Rather Be Writing Newsletter
Get new posts delivered straight to your inbox.