Search results

Swagger tutorial for REST API documentation

by Tom Johnson on Sep 14, 2015
categories: api-doc

I updated the Swagger tutorial in my API doc course. If you'd like to learn more about Swagger, you can follow along here for step-by-step instruction.

Swagger is a REST specification that allows you to generate interactive API documentation. I created a tutorial for using Swagger in the API doc course I’m working on.

In my Swagger tutorial, I show you how to use the Swagger Petstore example as well as how to build your own Swagger output. If you go through the tutorial, let me know if you have any feedback.

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.