Backend and Infrastructure

API Documentation and Testing

Check your version

This tutorial covers a topic in which may or may not be the version you're using. We're keeping this tutorial online as a courtesy to users of , but we consider it archived.

Alternate resources

Sprout Video

In this tutorial, I'll introduce the API Blueprint specification and take a look at a few tools we can use to provide documentation and testing for our API.

The tools we'll look at include:

By the end of the tutorial you'll have a better understanding of the API Blueprint specification and be able to use Dredd and Aglio to ensure your API documentation and testing stay up-to-date.

Self-check question: Could you write a script that could be run after every commit that would keep your documentation up-to-date, and provide API test results?

Additional resources

API Blueprint