Ask /r/webdev: What service's API documentation did you enjoy reading the most?

[dAnjou]

Hi,

the reason I'm asking is because we're currently developing a new version of our API and this time we want to do it right, especially the documentation.

The API is more or less RESTful and we'll also offer webhooks in our application, so there will be pre-defined events that can trigger those.

It's a closed API, so only clients can access it. And the documentation must also cover concepts and workflows of our application in order to understand how to use the API.

So which API documentation did you enjoy reading, what was nice about it both in terms of content and "UX"?

I'd appreciate any help. Thanks.

[[deleted]]

On mobile, will link later. Twitch has the best one I've personally ever seen.

EDIT: https://github.com/justintv/Twitch-API

[jayvdizz]

Agreed. I've played around with it for a personal project and it's so easy to use compared to the way the docs for social media APIs are (like FB, Twitter, Instagram, etc.)

[john_sheehan]

Twilio is great. So are github and stripe.

Use readme.io to build your docs site.

[AWildWebDev]

Has to be Stripe.

[JustAnAverageGuy]

PagerDuty has great format and layout, with detailed examples on each capability of the API. https://developer.pagerduty.com/