Search results

Slides for Documenting REST APIs Workshop — 2016 STC Summit Anaheim, Calif.

by Tom Johnson on May 14, 2016
categories: api-doc

Here are my slides for the Documenting REST APIs workshop I'm giving at the 2016 STC Summit in Anaheim, California. The workshop lasts 3.5 hours. These slides cover a host of topics, including how to use APIs, how to document APIs, how to publish APIs, and more. There are lots of hands-on activities throughout. Some of the activities involve using the command line, the Chrome JavaScript Console, Postman, Git, reading JSON, and more.

Here are the slides:

You can find more detail in my API doc course. (These slides are slightly updated from some of the topics in my course, but generally the slide number in the heading title corresponds with the course number.)

About Tom Johnson

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.