Implementing Swagger in your API documentation -- My ISTC article
If you’re an ISTC member, then you already get the ISTC Communicator, and you can read my article in print or by logging into the ISTC site. You can view the table of contents for the Autumn 2016 here (but not the article content unless you log in as a member).
If you’re not an ISTC member, you can read my article here: Implementing Swagger (OpenAPI specification) with your REST API documentation (PDF). I originally published this content on my API doc course, but the course content has since evolved and now the original article in that context is no longer there. See OpenAPI spec and generated reference docs for the latest approach.
A lot of people ask about Swagger, and although I’ve written about Swagger previously, this is my clearest and most thorough article on the topic to date.
About 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.