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.
Attend the webinar: Mon, 9 January , 2017 9:00 AM – 9:30 AM PST
Watch the Video
Visiting Dojo Master
Tom Johnson, I’d Rather Be Writing
Web-savvy technical writer with strong knowledge of APIs, passionate about creating documentation that pushes traditional boundaries to improve the user experience. Enjoy working in agile developer environments, knee-deep in code, double-checking instructions to make sure they’re as accurate, clear, and complete as possible. Artful with visual communication, especially creating diagrams, illustrations, and video tutorials.
About the TC Dojo
The TC Dojo is brought to you by Single-Sourcing Solutions. At the TC Dojo, you pick the topics and we find the experts. Be sure to vote on future TC Dojo webinar topics here: http://survey.tcdojo.org
Get useful tips and valuable resources every month
Join the thousands who know we give information away like candy.