Adobe FrameMaker

Get new posts delivered straight to your inbox.

Subscriber count: 4,300

Stitcher radio

Adobe FrameMaker

Swagger tutorial for REST API documentation

Sep 14, 2015 • 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.

follow us in feedly


Get new posts delivered straight to your inbox.

Subscriber count: 4,300

About Tom Johnson

Tom Johnson

I'm a technical writer based in the California San Francisco Bay area. Topics I write about on this blog include the following technical communication topics: Swagger, agile, trends, learning, plain language, quick reference guides, tech comm careers, and certificate programs. I'm interested in information design, API documentation, visual communication, information architecture and findability, and more. If you're a professional or aspiring technical writer, be sure to subscribe to email updates using the form above. You can learn more about me here. You can also contact me with questions.