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 presentation recording -- Harnessing the Chi of Swagger in your REST API documentation

by Tom Johnson on Jan 17, 2017 •
categories: api-doc

Recently I gave a presentation on Swagger as part of the TC Dojo webinar series. If you missed the presentation, you can view the Swagger recording here.

Here’s a description of my Swagger presentation, which was titled “Harnessing the Chi of Swagger in your REST API documentation”:

Frequently when tech writers start creating API documentation, a developer will ask, Why don’t we use Swagger? Swagger, or the OpenAPI specification, is an open standard for describing your REST API. The Swagger/OpenAPI spec, which is created in YAML or JSON, can be parsed by different tools, such as the Swagger UI framework. Swagger UI can create an interactive experience for users to try out your API calls using their own API keys. This can be a powerful addition to your API documentation, since it gives users a sandbox to experiment with your API in an immediate way.

Here are the slides and the recording:

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