In this workshop, you’ll learn about API documentation in the context of using a simple weather API — making requests and analyzing the responses. We’ll cover the essential elements of API reference topics (such as endpoints, parameters, and response schemas), how OpenAPI specification and Swagger work (as well as tools to simplify spec development), expected non-reference topics (such as authorization and rate limiting), version control workflows (in Git and GitHub), and more. If you’re starting to document a REST API, this workshop will get you up and running in the right direction. You’ll leave with a solid grasp of the necessary components of REST API documentation as well as how to deliver an interactive learning experience that developers want.

About

The Society for Technical Communication is a professional association dedicated to the advancement of technical communication. Technical communicators research and create information about technical processes or products directed to a targeted audience through various forms of media.