Ask HN: What is the best API documentation you have ever seen?

  • Stripe API docs. There have probably been many past threads about this.

  • Lodash.js every single piece is explained with complete lucidity, and even if it weren't the examples are concise and illustrative.

  • I do like the PostgreSQL docs, they have a human feel to them and I usually get the answer I want pretty quickly.

    https://www.postgresql.org/docs/10/static/index.html

  • Stripe is probably the best but I think Twilio is a close second. For both the page designs are easy to read, there are clear examples (some are even interactive), and the sites are easy to navigate.

  • Auth0's is pretty damn good. Clear docs, inline sample code...Auth0 even inlines your credentials into the example code if you're logged in.

    [1] Auth0 - https://auth0.com/docs/api/authentication

  • I really like the Lua reference manual. All on a single page (e.g. https://www.lua.org/manual/5.3/manual.html), covers the complete syntax/semantic of the language, a few concepts as well as its Lua and C embedding APIs. All without bells and whistles. It surely helps that it's a relatively easy language. While I learned Lua, I basically never had to look anywhere else for information. I guess that's what a good documentation is supposed to aim for.

  • Surprised I don't see Django here. I'm always relieved to come back to a django codebase, that is the best documentation on any project or framework I've used.

  • Possibly depends what you mean by "API", but I really like the SQLite documentation with its graphical representations of the query syntax.

  • Not an API, but the documentation for Haskell libraries is unbelievably good. Here's an example[1]. This documentation is generated automatically from source code, optionally decorated with comments using a simple syntax called Haddock[2]. Any package, whether it's built into the Haskell Platform or contributed by a user, has the same kind of documentation. Even if the author includes no Haddock comments, the documentation will include the type signatures, the hyperlinking, the instance lists, and other goodies like the minimal set of functions needed to define an instance of a class.

    [1] http://hackage.haskell.org/package/base-4.11.1.0/docs/Data-L... [2] https://www.haskell.org/haddock/

  • Airtable's API. Every API document is specific to you, playing around with GET/POST/PUT/PATCH/DELETE requests is really straightforward to understand, even for someone that isn't familiar with how these requests normally work.

    The sample json responses are also based on your data too, and the docs showcase what those look like

  • Qt docs, python docs, cppreference, code synthesis odb

  • Side note, how do I volunteer or work part time writing technical documentation?

    I feel like my writing skills and my ability to make code understandable and explicit to other readers would be a perfecy use for producing great documentation.

  • The requests package for python is nicely documented: http://docs.python-requests.org/en/master/

  • It's not an "API doc" in the modern sense, but the DEC VMS manuals are the best-written tech docs I have ever seen.

  • Not API, but Spark Java (http://sparkjava.com/documentation#getting-started) has one of the best Java framework documentation I've ever seen. Fairly concise + it has almost everything you need to build proper Web application using Java

  • Common Lisp HyperSpec - http://www.lispworks.com/documentation/HyperSpec/Front/index...

    My choice is, perhaps, more indicative of taste/proclivity than anything else.

  • EVRYTHNG Platform docs are extremely thorough and versatile. There're also lots of guides and examples covering how to work with their platform. Taking into account complexity and amount of abstractions, those are one of the best docs i've ever read.

  • I really like the Requests quickstart docs: http://docs.python-requests.org/en/master/user/quickstart/

  • I found sonic pi documentation engaging, easy to understand and comprehensive, https://sonic-pi.net/tutorial.html

  • Back in the day, the documentation for the 3DO seemed great. I was programming on another platform and remember looking at those manuals in envy!

  • I found the SFML documentation to be one of the few cases where I didn't find myself looking for third-party API documentation or tutorials.

  • Stripe and the worst one has to be Braintree.

  • plot.ly has quite nice documentation in very good detail - ESPECIALLY their examples using multiple languages

  • I still haven't found a single API as quick and easy to get started and test with than Flickrs

  • The manual that came with the Coherent (Unix) os by the Mark Williams Co.

  • Boto3 - Amazon’s AWS library for Python.

  • What are people's thoughts on Swagger?

  • i've found highcharts documentation to be really exceptional.

  • Stripe

  • MATLAB

  • Stripe and twilio are great

  • AWS CLI APIs in general are very clean and intuitive to follow through their help menus.