Net API Notes for 2020/12/15 - Issue 149

Season's greetings and welcome to this, the final Net API Notes newsletter for 2020. Saying that this has been a unique year is an understatement. And while there is indeed light on the horizon, there's still some time to go until we get there.

For you and yours, I wish health and (perhaps just as important) peace during these next several weeks. I hope you have the opportunity to reflect on what this year has taught you. Then, with some luck, we can meet up again in the new year a little calmer, a little wiser, and in celebration of the 150th issue milestone.

However, before we do that, let's review this, the issue's batch of notes!


(Special thanks to Vicki Boykis for use of her excellent meme)

NOTES

IN-DEPTH WITH EVENT-DRIVEN MICROSERVICES

Suppose you've taken a domain and successfully identified several bounded contexts. You recognize the benefit of abstracting the complexity behind many interfaces, but how do you get all the pieces communicating with each other with a minimal amount of coupling?

Oskar uit de Bos has a suggestion. In his Engineers' Guide to Event-Driven Architectures, he covers the pros and cons of this approach. Oskar also grounds his reasoning in foundational thinking, covering the cap theorem and how it applies to distributed systems.

It is a fantastic piece to noodle on during the holidays. Kind of like the next article:

MEET HYRUM AND POSTEL

Are you familiar with Hyrum and Postel? More importantly, did you know these gents have their own technology aphorisms?

Postel Robustness Principle says, "be conservative in what you do, but be liberal in what you accept from others".

Hyrum's Law says, "with a sufficient number of API users, it doesn't matter what the interface promises, all observable behaviors will be depended on by somebody".

David Biesack is familiar with both concepts. In his piece, Meet Hyrum and Postel, David introduces both concepts and covers their impact on API design.

PHIL STURGEON ON DEPRECATING API ENDPOINTS

When Phil isn't shooing away wifi-blocking cattle or guerilla gardening on a planetary scale, he writes API articles. His latest, appearing on the Stoplight blog, is a refresher on Deprecating API Endpoints.

Experienced API designers might assume they know all there is to this topic; develop a versioning strategy and move on. However, if that's the extent of your thinking on this, you're missing out. Phil goes to great lengths to detail the nuances of API Evolution. That's a strategy where only non-breaking changes are allowed to a particular API and, when that no longer becomes tenable, creating a new resource all together for the new hotness.

Phil also illustrates how to communicate changes within an API's OpenAPI document. Finally, there's nice coverage of deprecation and sunset headers. Lots of great stuff in this piece for new and old API hands alike.

MILESTONES

WRAPPING UP


Thank you to my Patreons. Perhaps this rag isn't worth your donation. Fair enough. I would, however, encourage those with the means to look around them and consider donating to those services and institutions that have been impacted by Covid-19 (and the subsequent economic downturn). In the latter part of this year, I set up recurring donations to The Internet Archive and The Markup, a nonprofit newsroom pioneering data-driven investigative journalism. I'll also be supporting the Wikimedia Foundation and several local food banks.

If there's one thing that 2020 taught me, it is that cynicism is easy. Giving one's time, energy, and money is hard. I get it. I'm still working on this myself. However, without hesitation, I'll vouch that the returns are worth it.

Please consider donating where and whatever you can. Stay safe. Happy holidays. I'll see you in 2021.

Till next time,

Matthew @libel_vox and matthewreinbold.com

Subscribe to Net API Notes

Don’t miss out on the latest issues. Sign up now to get access to the library of members-only issues.
jamie@example.com
Subscribe