TE
科技回声
首页24小时热榜最新最佳问答展示工作
GitHubTwitter
首页

科技回声

基于 Next.js 构建的科技新闻平台,提供全球科技新闻和讨论内容。

GitHubTwitter

首页

首页最新最佳问答展示工作

资源链接

HackerNews API原版 HackerNewsNext.js

© 2025 科技回声. 版权所有。

Ask HN: Which companies have the best api documentation?

2 点作者 xchefhatx大约 8 年前
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

beamatronic大约 8 年前
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.