Sitemap
Javarevisited

A humble place to learn Java and Programming better.

Member-only story

How I Design APIs As Senior Developer For Better Results

10 min readSep 6, 2026

--

Bad developers do not write most bad APIs. Rushed developers do.

I know because I have built a few of them. And one of them still runs in production and requires constant rewriting.

Last quarter I reviewed the Orders API behind our new mobile app. At a glance, it looked fine. But once I read it properly, I found serious issues in it.

Press enter or click to view image in full size

I want to walk you through how I redesigned it. The first few decisions are the basic ones most of us already know.

But the others are often ignored. That is exactly where bad API design starts to hurt.

Non-medium members click here to read for free.

The Problem With the Current API

Here is what the API looked like when it reached me:

Press enter or click to view image in full size

And the response from /getOrderById:

--

--

Just your friendly neighborhood full-stack developer. Building awesome applications, one line of code at a time.

See more from me

Javarevisited
Javarevisited

Published in Javarevisited

A humble place to learn Java and Programming better.