Document 360: #1 Knowledge Base Software
Stay updated
Keep current with the latest trends in technical communication by subscribing to the I'd Rather Be Writing newsletter. 5,400+ subscribers

Search results

Document 360: #1 Knowledge Base Software

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.

Stay updated
Keep current with the latest trends in technical communication by subscribing to the I'd Rather Be Writing newsletter. 5,400+ subscribers

follow us in feedly

About Tom Johnson

Tom Johnson

I'm a technical writer based in the San Francisco Bay area. In this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, visual communication, information architecture, writing techniques, plain language, tech comm careers, and more. Check out simplifying complexity and API documentation for some deep dives into these topics. If you're a technical writer and want to keep on top of the latest trends in the field, be sure to subscribe to email updates. You can also learn more about me or contact me.

Comments