Connect the Docs

Natalie Perpepaj is a software engineer at Community, focusing on building automated workflows while preserving conversational interactions at scale.

Natalie enjoys playing cards, drawing, and holds a black belt in napping. Fun fact: Natalie once held a job collecting ticks for her college’s ecology lab and the CDC.

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.