The world of technology is more accessible than it was ever before. Countless pieces of software are
being developed every day. And not just that, the production pace is faster than ever. When we are
talking about APIs, the design process can be rather quick.
As a matter of fact, you can always find a great number of tools and frameworks online to help you with
your web API architecture design – all you need is some patience to learn how to operate them.
However, a quick design process has some perks that come with the territory. Those perks sometimes
can be fatal for your API or your whole application. Unfortunately, many people don’t have the patience
needed to do the job correctly.
In order to help you get everything right on the first try, we are going to go through a couple of common
1. Unforeseen Code Errors
In an ideal situation, an error will show the developer what the problem is, where it is, and how to fix it.
When API`s error message is not so good, it can test your nerves and of course, waste your time. A bad
error message can notify you that there is a problem, and lead you to a false location. On top of that, it
can show you more nonexistent problems along the way.
We understand that following the instructions is not a popular way of doing things. But with good usage
of HTTP status and error messages, you can save a lot of your time. On the internet, you can find a lot of
good examples of error messages and status codes. Some of them are so good, that their error
messages are including links that can help the developer in the future.
2. Returning Invalid Content-Type
This is probably the most annoying errors you can encounter while designing an API. How many times
you’ve had to spend hours to find a resolution to a seemingly absurd problem? For example, how many
times you’ve forgotten to write DOCTYPE HTML line? Pay attention to details, because your API can be
pretty strict about those things. Especially if you’re designing an API that uses HTML by default.
3. Sending Invalid Authorization Credentials
More often than not, APIs that have implemented OAuth 2 will ask for authorization for every request
they encounter. In our experience, authorization can be mistaken for authentication in some situations.
As silly as that sounds, believe us, it is pretty common. So if you see that your request failed, check again
if you are using the right word.
4. Using the Wrong HTTP Method
While this error isn’t as silly as the previous one, it’s still pretty easy to solve. Luckily, using the wrong
HTTP method can be straighten out in just a couple of minutes. When this happens, most of the times
you can see that bad-written documentation is the source of the problem. The tools can trick you if you
are not paying attention. Sometimes it happens that you just used a wrong method.
5. Typing HTTP Instead of HTTPS
Testing an API can get you into a trouble if you forgot to type HTTPS. Some of the APIs support only
HTTPS, while others can support it for some parts and not for others. Even if your API supports both of
those, you can run into a wall. Some of the APIs can stop supporting HTTP so it is crucial for your API to
Your API probably supports HTTPS. The process for getting those certificates can be difficult sometimes.
Although, on the internet, you can find some solutions to that problem. Sometimes, people can be a
little uncertain if this is really needed. From our experience, we can say that this is pretty crucial for
Most mistakes made in the development process are due to developer`s impatience. Big companies
have a saying “produce as much as you can, in a shorter period.” Some of those mistakes can cost you a
lot, so try to keep your eyes open as much as possible.
We went through some of the more common mistakes, but the list could’ve been a lot longer. However,
the mistakes we listed are the ones that are staggering tons of projects around the world every day. It is
important to acknowledge those mistakes and avoid them in the future.
Thank you for reading our article. We hope that it was enjoyable and informative. If you like this article, then please share it with your friends and groups.