Here is a description of the API workshop I’m giving in Sacramento:
Workshop on Documenting REST APIs
At its core, REST API documentation focuses on documenting requests and responses. You describe the various endpoints available, their methods, parameters, and other details. And you also document sample responses from the endpoints, usually describing each element and providing sample code.
In this workshop, you’ll learn the basics of REST API documentation. We’ll dive deeply into the following topics:
- Resource descriptions
- Endpoint definitions and methods
- Sample requests
- Sample responses
- Error codes
- Code samples
You’ll also learn about a few tools and technologies that are useful in working with and testing REST APIs. Some of these tools include the following:
- The command line
- Chrome’s Developer Console
- Postman REST client
With REST APIs, there’s not usually a GUI interface for users to navigate. Instead, the documentation itself provides the interface that users navigate. Because of this, we’ll also explore various ways to publish your API documentation. Here are a few platforms we’ll cover:
This course will mostly provide an introduction to these concepts. There are many detailed examples and activities you can walk through with the API documentation tutorials on my site here: http://idratherbewriting.com/learnapidoc/
All participants in workshop will need the following:
- Text editor (such as Sublime Text)
- Postman REST client
In addition to covering technical strategies for documenting REST APIs, we’ll also talk generally about the job market for developer documentation, the skills in demand, and challenges in working in developer environments.
You can find more information on the STC Sacramento site here.
Note that I’m also giving a similar API documentation workshop at the STC Summit in Anaheim, California in May (though the cost is 10 times as much).
If you’re interested in API documentation but can’t attend either of these events, you can get the same information from my site here: API documentation course.
Get new posts delivered straight to your inbox.
I'm a technical writer based in the California San Francisco Bay area. Topics I write about on this blog include the following technical communication topics: Swagger, agile, trends, learning, plain language, quick reference guides, tech comm careers, and certificate programs. I'm interested in information design, API documentation, visual communication, information architecture and findability, and more. If you're a professional or aspiring technical writer, be sure to subscribe to email updates using the form above. You can learn more about me here. You can also contact me with questions.