I thought I'd ask, what do you think makes for a good api?
Ask HN: What makes an API good?
1–10 of 68 posts
Re: Ask HN: What makes an API good?
#2Re: Ask HN: What makes an API good?
#3Re: Ask HN: What makes an API good?
#4Re: Ask HN: What makes an API good?
#5Documentation is without question the deciding factor of whether I'll use a service.
Besides that, I care about support channels, adherence to standards (i.e. correct HTTP status codes), and as few hoops as possible to jump through to start (i.e. a curl command to get my auth key, and away I go)
Re: Ask HN: What makes an API good?
#6There's very little universal about a "good" API design. Even response time might not matter if your users aren't using it synchronously. Best way to make an API is to have a plan to support old versions, release something early, see what people make of it and incorporate their improvements. Worst way to make an API is to try and think of everything before you start - you will fail and you'll take a long time
Re: Ask HN: What makes an API good?
#7Not just a link to the Javadocs; preferably a "getting started" page that covers the most common use cases with plenty of plug and play examples (if such a thing is even possible in your case).
Also, getting back to the API reference, I'm grateful when there is a roadmap or overview of the class/package structure so I don't have to crawl through the entire thing.
Re: Ask HN: What makes an API good?
#8Re: Ask HN: What makes an API good?
#9Re: Ask HN: What makes an API good?
#10You might want to check out The Little Manual of API Design: http://www4.in.tum.de/~blanchet/api-design.pdf