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: Best Documented Web APIs and Integrations?

17 pointsby philippzover 7 years ago
Title contains the questions. There are so many documentations of various styles out there.<p>Which are the best API documentations you know? Comprehensiveness, Readability, Usability&#x2F;UX, Look&amp;Feel, extensive use of standards... whatever factor makes it special&#x2F;favourable.<p>Looking for role models.

5 comments

ryanwaggonerover 7 years ago
Stripe, Parse, Twilio, SendBird.<p>This is a good overview of the different things that make up great docs: <a href="https:&#x2F;&#x2F;zapier.com&#x2F;engineering&#x2F;great-documentation-examples&#x2F;" rel="nofollow">https:&#x2F;&#x2F;zapier.com&#x2F;engineering&#x2F;great-documentation-examples&#x2F;</a><p>I think a great developer docs experience is a <i>really</i> tough thing to do well. You need to have great design, great writing, and great tech. The existing docs platforms out there (like Readme.io) all suck (especially for anything beyond REST API docs), so you really need to roll your own.<p>I&#x27;ve done some consulting in this area for clients who wanted amazing docs experiences, so ping me if you want some more ideas &#x2F; feedback.
davedxover 7 years ago
Stripe is probably the best I&#x27;ve used, though there are so many products and features these days you can get a bit lost sometimes.
评论 #15225757 未加载
gmover 7 years ago
Follow up question: Is there a framework for creating and maintaining these API docs, or is it hand-coded?
评论 #15218469 未加载
评论 #15218341 未加载
shash7over 7 years ago
Airtable has a pretty awesome api documentation.<p>Basically, when you create a table and see its api documentation, it is generated on the fly to show you the rest endpoints specific to that table only.<p>Pretty awesome actually, worth checking it out.<p>Stripe has good api docs too.
levyeladover 7 years ago
<a href="https:&#x2F;&#x2F;docs.particle.io&#x2F;reference&#x2F;api&#x2F;" rel="nofollow">https:&#x2F;&#x2F;docs.particle.io&#x2F;reference&#x2F;api&#x2F;</a><p>Amazing IoT startup and amazing documentation