4 ms·
Ask HN: What is the best example of api documentation you know?
I am researching documentation for api's. What makes a good documentation? What sections and articles are interesting for new and old users etc? Do you have any favorite documentation and why?
Thanks
- vhf 12y agoTake a look at beautiful docs[0] [0] https://github.com/PharkMillups/beautiful-docs https://github.com/PharkMillups/beautiful-docs
- uka 12y agoI like stripe-s documentation for their REST API https://stripe.com/docs/api https://stripe.com/docs/api curl examples are the thing that impress me the most ...
- ndc 12y agoExamples examples examples. From the most common use cases to the less common. With annotations and links to the endpoint reference.
- 650REDHAIR 12y agoExamples, examples, examples. I also love the Google Maps API. They're certainly in my top 5 for API documentation.
- murtza 12y agoTwilio, Stripe, Parse, Sendgrid, Mailgun are examples of companies with good documentation. Generally, I like to see a high-level overview of the API, authentication scheme, endpoints, sample request and response, error code explanations, and sample code coverage in multiple languages. I wrote a blog post on this topic: http://murtza.org/creating-a-great-developer-experience/ http://murtza.org/creating-a-great-developer-experience/
- RobSpectre 12y agoMuch obliged for that. We still have a lot of work still here at Twilio to do around our documentation - appreciate the vote of confidence. Some of the stuff the DevX team is working on right now has me really excited. Hope you'll share what you think when we release it.
- cjbarber 12y agoI'd add BlockScore to that list: https://manage.blockscore.com/docs/index https://manage.blockscore.com/docs/index
- krrishd 12y agoI don't have a favorite company with good documentation, but these two tools have been useful and seem well designed for creating docs: - http://daux.io http://daux.io - http://raneto.com http://raneto.com
- doug1001 12y agoNew York Times Article Search API: http://developer.nytimes.com/docs/read/article_search_api_v2 http://developer.nytimes.com/docs/read/article_search_api_v2 everything a dev might ever want to know about constructing a query, calling this API, and parsing the results--beautifully accessible from this homepage
- nardbard 12y agoI second the vote for Twilio, adding NPR to the list http://dev.npr.org/#story-lists-api http://dev.npr.org/#story-lists-api
- sootn 12y agoOo this is great everyone! I really like that sexy Stribe documentation. Thank you