How NOT to Design Your API

DZone 's Guide to

How NOT to Design Your API

· Java Zone ·
Free Resource
Recently I tweeted as a #linktuesday link the 10 Worst API Practices post from ProgrammableWeb. Today, in search of some concrete examples of APIs implementing unhelpful antipatterns, I sent out a tweet for help:

What's the most frustrating inconsistent/misleading bit of API you've seen? Looking for cautionary tales! Please RT

In the raft of responses (and thankyou all, this was fabulous, helpful and entertaining in equal parts!), there were some definite patterns that I'd like to share with you, in no particular order.

The Patently Untrue 200 Response

This got plenty of mentions, and it's definitely a pet hate of mine!

@ response codes that don't match the content. i don't want to see a 200 when something has gone wrong or is missing!
Rich Sage

@ HTTP 200 with "X-MailChimp-API-Error-Code: -90" header ...
Rafael Dohms

@ in general: the ever classic 200 response with a text body explaining that the request actually failed
Lukas Kahwe Smith

@ HTTP 200 with a body containing "NOT FOUND" or "ERROR"
Nuno Costa

@ NullPointerException
Andries Seutens

@ in the body of a response with HTTP status 200 OK
Andries Seutens

A Consistent Case of Complete Inconsistency

These aren't all the same complaint but they are basically the same problem!

@ APIs that have different urls for collections vs. items in collection: /issues vs /issue/157. So hard to remember to C-h.

@ How about order sensitive XML? (yes, really), or SOAP which takes an XML package as an argument. /cc @
Jacob Mather

@ Collection end points that return an array of items if more than one, but return a single item itself if only one.
Rob Allen

@ API's with nutty error handling - sometimes HTTP error codes, sometimes special "envelopes" for error instead of data, etc.

@ http://t.co/fQ6LXveJ: APIs which use a "method" parameter and mix German/English in the method names
C. Hochstrasser

Documentation From a Parallel Universe

Is no documentation better than inaccurate documentation? I'm never really sure of the answer, but it does seem like a common problem.

@ @ Facebook's API is probably the worst I've had the misfortune of using. Their documentation is a mess too.
Jonathan Paylor

@ Facebook API's are a world of joy. Documentation is more marketing speak than actual tech docs. Data types are not really spec'd
Ward Bekker ✅

@ paypal for sure, seems like even its maintainers somehow lost control over the different versions of docs and api
Oliver Zeigermann

@ some examples: implicit wrong-context escaping (Twitter), serving improper Content-Type, XML-within-JSON. Also: incorrect docs.
Sean Coates

@ @ incorrect docs+++ I think I'd rather have NO docs for an API and try to fiddle with it than wrong docs!

@ facebook. mostly because of the ever evolving aspect without any clear docs or information policy
Lukas Kahwe Smith

So there you have it, the sins to avoid in your own APIs. If you've encountered any of these, please accept my condolences.


Published at DZone with permission of Lorna Mitchell , DZone MVB. See the original article here.

Opinions expressed by DZone contributors are their own.

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}