In the spirit of a dojo, my presentation is called Harnessing the Chi of Swagger in Your API Docs. Here’s the description:
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.
Date: Mon, Jan 9, 2017
Time: 9:00 AM - 9:30 AM PST
Interested in previewing my slides? You can check out an early draft here, though I’m still working on them.
Jan 10, 2017 update: If you missed the presentation, you can watch it here:
Get new posts delivered straight to your inbox.
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.