Test all the things - Automated Testing of (RESTful) API Documentation

A presentation at APIdays Australia 2017 in in Sydney NSW, Australia by Rouven Weßling

There are few things more frustrating than documentation that doesn't match the implementation - especially when it's documentation for your customers. In actively developed software that is a reoccurring problem. As the product evolves the documentation often lags behind and sometimes breaking changes sneak it, breaking the very examples that are part of the documentation. To avoid all these problems, it's time to start testing your docs. In this talk I'll show you what's currently possible when it comes to testing documentation, how to start testing API documentation written using API Blueprints and how to incorporate it into your workflow.


The following resources were mentioned during the presentation or are useful additional information.