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:
https://twitter.com/i/web/status/289014953954930688
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!
- https://twitter.com/i/web/status/289017133608882178
- https://twitter.com/i/web/status/289017192115228672
- https://twitter.com/i/web/status/289021466765320193
- https://twitter.com/i/web/status/289021745887854592
- https://twitter.com/i/web/status/289021973542096896
- https://twitter.com/i/web/status/289022236214575104
A Consistent Case of Complete Inconsistency
These aren't all the same complaint but they are basically the same problem!
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.
- https://twitter.com/i/web/status/289017348516614144
- https://twitter.com/i/web/status/289019749323653120
- https://twitter.com/i/web/status/289021046164688896
- https://twitter.com/i/web/status/289020763946749952
- https://twitter.com/i/web/status/289020918041296896
- https://twitter.com/i/web/status/289021114959663104
So there you have it, the sins to avoid in your own APIs. If you've encountered any of these, please accept my condolences.