TE
TechEcho
Home24h TopNewestBestAskShowJobs
GitHubTwitter
Home

TechEcho

A tech news platform built with Next.js, providing global tech news and discussions.

GitHubTwitter

Home

HomeNewestBestAskShowJobs

Resources

HackerNews APIOriginal HackerNewsNext.js

© 2025 TechEcho. All rights reserved.

Ask HN: Which companies have the best api documentation?

2 pointsby xchefhatxabout 8 years ago
Sooo, I just had to integrate with a pretty crappy api with even worse documentation.<p>In order to be a good tech citizen, I&#x27;d like to offer some examples of companies that have gotten documentation &quot;right&quot; to the vendor I&#x27;m working with.<p>Which companies have particularly great api&#x27;s and accompanying documentation?<p>Please reply with links and reasons ;)

1 comment

beamatronicabout 8 years ago
A bunch of companies use Swagger&#x2F;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.<p>When it comes to API docs, my ideal preference is for curl command-line examples, since that is sort of a universal &quot;least common denominator&quot; that works anywhere, everyone can understand. It also takes your particular client out of the equation.