[author:alex]
I’ve spent the last 6 months pouring over two-dozen web/app API reference documentation sites, for various uses.
Unfortunately, 98% of them suck.
So we set out to create new API docs for Jidoteki.
It’s sad to say this, but I think Amazon AWS is probably at the top of the list of worst documented APIs. Sure it’s extensive, but that doesn’t excuse them. I understand their need to support multiple languages, eleventy billion API calls, and a gazillion different parameters, but I digress. It’s horrible.
On the other hand, our API is tiny (for now), and so are most of the other web services we use. So the question is, why do most API docs suck?
I don’t know.
The point is, we at Unscramble, love Stripe. Their API documentation is light-years ahead of the game.
We love it so much, that we decided to copy it. Yeah I know we might get in trouble for doing this, but it was soooo well designed that we completely ripped off their design and created an Open Source version of it.
I want you to see it. I want you to play with it. Fork it on GitHub, make some improvements, send us a pull request, and use it for your own API documentation.
If the entire world used Stripe’s API documentation format, the world would be a much better place.
Do the world a favour. Check out our API docs, and use it for yourself: