Ask HN: Which companies have the best api documentation?

Sooo, I just had to integrate with a pretty crappy api with even worse documentation.

In order to be a good tech citizen, I'd like to offer some examples of companies that have gotten documentation "right" to the vendor I'm working with.

Which companies have particularly great api's and accompanying documentation?

Please reply with links and reasons ;)

1 comment

[ 3.2 ms ] story [ 11.2 ms ] thread

beamatronic 9y ago ↗

A bunch of companies use Swagger/IO Docs for their API docs, which allows you to enter parameters and actually try it out right there on the page - you can see the actual http request and response.

When it comes to API docs, my ideal preference is for curl command-line examples, since that is sort of a universal "least common denominator" that works anywhere, everyone can understand. It also takes your particular client out of the equation.