Connect the Docs

Geoff Smith is a software developer at Community where his team enables people to communicate with their audience personally and at scale.

He’s a gardener, recovering arts-nonprofit admin, and dog-dad in Denver with interests in permaculture and cybernetics.

Generating and maintaining web API documentation is daunting for a large code base, and many solutions require regular manual maintenance that does not guarantee correctness or accuracy.

The speakers introduce Connect the Docs, a new documentation tool that generates an OpenAPI specification by leveraging controller action unit tests. With sufficient unit test coverage, a team can generate accurate, consistent web API documentation by running their existing test suite (with just three lines of code!). This library also enables tracking any drift in an API contract if it is integrated into a continuous integration platform.