November 20, 2017: Introduction to API Documentation

In Silicon Valley, there’s no greater demand for tech writers than with API documentation roles. This is primarily because, unlike traditional documentation around user interfaces, APIs are primarily marketed through their documentation. As such, the API documentation has a huge impact on the success and adoption of the API.

At its core, REST API documentation focuses on requests and responses. You describe the various endpoints available, their methods, parameters, and other details, and you also document sample responses from the endpoints. To test the endpoints, you often make sample requests using tools such as cURL and Postman.

In this presentation, you’ll learn what a REST API is, the 8 essential sections in endpoint reference documentation, and how to test and analyze API requests. You can find more details in my API documentation course here.

About Tom Johnson

Tom JohnsonTom Johnson works as a technical writer for Amazon Lab126 in Sunnyvale. He writes regularly on his blog, http://idratherbewriting.com. You can learn more about him here.

Date: Monday, November 20, 2017
Networking/social time: 6:00-7:00pm
Presentation time: 7:00-8:00pm+
Location: IHOP Restaurant, 4200 Great America Parkway, Santa Clara, CA 95054
Cost: Free
Note: You don’t have to be an official STC member to attend the meetings.
This entry was posted in Meetings and Events. Bookmark the permalink.