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: Why is there no standard for (RESTful) API documentation?

4 pointsby dennybritzover 11 years ago
I just had to read through incomprehensible API docs. It's painful. Why isn't there a standard for API docs, just like there is a standard for language-specific library docs (e.g. rubydoc)?

4 comments

dragonwriterover 11 years ago
There&#x27;s no standard for RESTful API docs because a RESTful API, per se, doesn&#x27;t need docs. If an API is really RESTful, the content types used in it need documentation which describes both the content structure and the meaningful operations against it, and with those the API is self-describing.<p>Of course, most &quot;RESTful&quot; APIs are variations on RPC over HTTP, not actually RESTful.
ismaelcover 11 years ago
(Disclaimer: I work for Mashape). There are tools&#x2F;services that help address this like Mashape, IO Docs, Swagger, etc.
veesahniover 11 years ago
There isn&#x27;t a standard for RESTful APIs, which makes it hard to provide concrete standard for RESTful API docs.
cotsogover 11 years ago
Also check <a href="http://apiary.io" rel="nofollow">http:&#x2F;&#x2F;apiary.io</a>.