Hacker News new | ask | show | jobs
by nerdyadventurer 1566 days ago
Any good resources on API design?
2 comments

Surprisingly enough (to some, including me), Microsoft's REST API design guidelines are both thorough and there's very little I'd object to.
There is incredibly good information on Microsoft's site for developers
I'm surprised anyone finds this surprising. Like them or not, Microsoft makes tight documentation for developers.
I found it surprising because I interacted with their REST APIs first. They are very good about docs. The ones I use most frequently (TS) are no exception, though they have some gaps. But the actual REST APIs I integrated very clearly predate a lot of their guidelines or struggle to follow them.
That's true of everything I've worked on. Little details keep sullying my perfect design for reasons end users aren't aware of.
maybe they are able to create good docs, and good guidelines, because they burned themselves in the past creating godawful ones?
I don't remember any bad MS docs and I've been using them on and off since the 1990.
There was just an article on HN a couple of days ago: https://news.ycombinator.com/item?id=30647784

Comments were very insightful as always. I kind of agree with OP, this article is very thin on content and mostly peripheral take on good API design. It is unhelpful.