The Elements of APIs

A shortcut

I’m going to show you my conclusions first, and then we’ll work backwards and talk about why each of these things are important. If you just read this list and go forth to build an API that checks all these boxes, I’m proud of you. If you’re skeptical about why all these things—all these things—are essential, keep reading and we’re going to get into it.

This is a process I’ve used countless times, for tiny projects and for huge projects. It leaves very little room for bikeshedding. By framing it like this, non-technical stakeholders can help, and often they have important insights that the engineers might not be thinking about.

We’re going to get into all the details, but just keep all of this in mind.