Category Archives: API Design

What is the difference between synchronous and asynchronous communication?

And will adding the async keyword to my .NET api make it asynchronous? No not in the sense of asynchronous architecture. let me explain. A Restaurant Analogy Let’s take a real-life example of a restaurant. And at this restaurant customers need to go to the counter to get served. In the first example, the server has NOT been… Read More »

AWS ReInvent: API Design takeaway

Following AWS Reinvent 2021 I’d like to share some of the golden nuggets I have taken away from the keynote regarding #apis ⁃ Primitives not frameworks (don’t build the kitchen sink, build small components) ⁃ Join small components to build larger complex systems ⁃ #APIs enable customer-centric innovation ⁃ Trying to create uniform APIs before you understand the… Read More »

Stop making this API design mistake, stop returning just a value in your API responses. Always return an object | #API Design Tip

Web APIs SHOULD NOT just return a boolean, string or a number/integer value in the response body for any response. Take the following. If you have an operation which for a successful (2XX) creation operation, returns just the value of the new object’s identifier in the response body, like the below examples, then you are opening yourself to… Read More »