Sauntering Beyond Swagger with Open Source Tools | Jessica Parsons | API The Docs Chicago 2019
Channel: API the Docs
Date: 2019-05-06

"Sauntering Beyond Swagger with Open Source Tools"  by Jessica Parsons, API The Docs Chicago 2019

Talk Description:
"The OpenAPI Specification (or OAS, also formerly known as Swagger) provides a powerful foundation for connecting API source code, SDKs, and documentation around a single source of truth. With the right tools, docs can be synced automatically with changes in source code, but finding and choosing those tools can be an overwhelming task. I’ll share how our team navigated the landscape, and present the tools we selected, or developed, as a result.

While there are a number of fine proprietary tools for managing an OpenAPI spec and generating documentation from it, our team sought the portability and flexibility of an open source solution. I’ll explain our initial state, using the standard Swagger UI implementation, and outline how we evaluated our options for a new documentation generator. I’ll also describe our challenges in finding a content management tool for editing the spec source file, and share the solution we developed in response.

This session is recommended for writers and API engineers looking for ways to connect their work in a way that allows all parties to contribute to great API documentation while working in tools where they feel comfortable."

API The Docs Chicago 2019 recaps: https://pronovix.com/event/api-docs-chicago-2019
---

API the Docs is an event for tech writers, API developers, product owners and developer evangelists who embrace documentation as a crucial aspect of a great developer experience. The conference is a great opportunity to share and discuss the latest best practices, strategies and new trends relevant to API documentation and developer portals.

Pronovix Developer Portals Newsletter:  http://bit.ly/devportals