Adobe Robohelp

Get new posts delivered straight to your inbox.

Subscriber count: 3,725

Stitcher radio

follow us in feedly

Want more tech comm blogs to follow? See my Tech Comm Collection of Blogs on Feedly.

Adobe FrameMaker

Swagger presentation recording -- Harnessing the Chi of Swagger in your REST API documentation

Jan 17, 2017 • 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:

follow us in feedly


Get new posts delivered straight to your inbox.

Subscriber count: 3,725

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 technical writing, authoring and publishing tools, API documentation, tech comm trends, visual communication, technical writing career advice, information architecture and findability, developer documentation, 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.