avatar

Wojtek Erbetowski

Good API documentation is executable

Abstract

How do you keep your REST API documented? Online description? Or maybe a spreadsheet/doc? Think about how does your consumer discover it.

Poor one is pasting URLs to curl or POSTman, right? And he’s mad as hell, as documentation is out of sync with code as soon as it’s written. Not to mention submitting bugs looks like an email ping-pong. It’s not 2010 any more, you know? Let’s jump into cool tools that will improve your consumers’ life and save you some time.