---
title: "Implementing Swagger in your API documentation – My ISTC article"
date: 2016-09-08
description: "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..."
canonical_url: https://idratherbewriting.com/2016/09/08/swagger-article-for-istc-publication/index.html
---

> For AI agents: a documentation index is available at https://idratherbewriting.com/llms.txt. Markdown versions of all pages are available by appending .md to any page URL.

# Implementing Swagger in your API documentation – My ISTC article

> I recently published an article about Swagger in the Autumn 2016 edition of ISTC's magazine, Communicator. ISTC stands for Institute of Scientific and Technical Communicators. My article provides an introduction to using Swagger (now called OpenAPI specification) for publishing your REST API documentation.

If you’re an ISTC member, then you already get the [ISTC Communicator](http://www.istc.org.uk/publications-and-resources/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](http://www.istc.org.uk//images/2016/05/Comm1609Web_TOC.pdf) (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](https://s3.us-west-1.wasabisys.com/idbwmedia.com/images/stc_communicator_swagger.pdf) (PDF). I originally published this content on my [API doc course](https://idratherbewriting.com/learnapidoc/), 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](https://idratherbewriting.com/learnapidoc/restapispecifications.html) 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.