Skip to content

Announcements

New Chapter of Requirements & API - Interface Definition Languages (IDL)

A new chapter in the Requirements & API series continues uncovering API design specifics. This time, we look closer into IDLs (Interface Definition Languages).

I examine OpenAPI as an industry standard, Microsoft-powered rival TypeSpec, and an underdog JSight. They have a similar purpose but achieve that in very different ways.

We are approaching the end of the journey. In 2025, one more article will describe API workflows.

For now, that's it for 2024. Of course, there will be an overview reflecting on the past year and sharing some plans for the upcoming one.

Stay tuned!

Previous chapters:

New Chapter of Requirements & API - Design

A new chapter in the Requirements & API series focuses on structuring each layer to design an API. This time, it is more practice-oriented, with examples of an HTTP API call and its OpenAPI definition.

I am in the hallway through that series. Almost a year ago, I did two webinars on the topic. Those articles help look deeper into the topic, which is better done in writing.

I originally planned to retell my material from offline and online events. However, reality is different, so there are many deviations and extensions.

So, two more chapters will come, and the topic will be closed. I have been writing and talking about APIs since 2022. I continue working as a product manager on the API Platform, and the articles about APIs get more attention from the audience than anything else.

So enjoy reading on Medium (friend link)

Or here: Design

Previous chapters:

A new part of Requirements & API - Analysis is available!

Last month, I started summarizing all my API-related posts, workshops, and webinars into extended and structured reading. That is usually a part of the Essays section, where you can find my recent Replacing Legacy series.

Reflecting on my past materials about API, I realized they were disconnected and lacked a logical narrative. However, I am proud to share that I am starting anew, from simple concepts to in-depth reviews of various Interface Definition Languages, showing significant improvement in my approach.

The new chapter, "Analysis," focuses on business analysis and aspects of requirements engineering. That was tough to write and edit, cutting pieces that did not fit and made text difficult to comprehend. Hopefully, I will get a satisfactory result.

Previous chapters:

  • Definitions, the best place to start the journey.
  • Glossary that I keep up-to-date with terms and abbreviations.
  • The index page is where you can find a plan for future topics.

At the same time, I am publishing it on my Medium to reach a broader audience. I would appreciate your support there.

Next time, we discuss HTTP protocol and API structure using OpenAPI as a reference.

Stay tuned and take care,

Ilya

Entire "Replacing Legacy" series is available on the Blog

For those who are not Medium fans, I've packed the Replacing Legacy series into the long read available on my blog.

There are some slight differences from the original: some passages have been edited, and others have been removed. Text is now more straightforward, but there are still a lot of places for improvement.

Now everything is in one place. I hope you enjoy reading.

And a few more updates:

-> I keep experimenting with formats and media platforms. Now, I will no longer publish unique content on one platform, like I did with the above-mentioned series on Medium.

I will simultaneously post on Medium and my blog. On LinkedIn, I publish a link to the blog with a short summary. So there will be a choice of where to read. And I will not spend time again migrating content from one place to another.

I am unsure about maintaining LinkedIn Articles, as last year's experience was not the best. The traction was minimal compared to a usual post.

09.11.2023 Webinar "Requirements & API. Part 2" for IIBA Belarus

Following a theoretical Part 1 of the "Requirements & API" webinar, the second part will come on November 9 at 18:00 (GMT+2). Here is a LinkedIn event with a Zoom link.

We will dive into API design-first, OpenAPI specification, and related tooling. Also, we will review a few practical cases and API patterns.

See you there!

As I mentioned, the entire webinar is based mainly on my API Design series, which I have worked on throughout this year.

I will publish the recording as soon as it is available.

Stay tuned!

26.10.2023 Webinar "Requirements & API. Part 1" for IIBA Belarus

I am proud to announce that I am hosting a two-part "Requirements & API" webinar for the IIBA Belarus Chapter.

Part 1 will happen on October 26 at 18:00 (GMT+2) - a LinkedIn event link. The second part will come two weeks later.

That is an online version of the workshop I made in Warsaw this February. There was great interest in the event. However, many folks could not travel to Warsaw for this specific event. So, there was an idea to transition it to online.

New Blog version with MkDocs

In early 2021, at the climax of the Covid-19 outbreak, locked up in the apartment with my wife and 6-month-old kid, I decided to have my blog. I will not dive into the reasoning there. I decided that sharing my thoughts on the media platform I own was a good idea.

My initial requirements were:

  • free hosting
  • own domain
  • control over the content and publishing capabilities

A static site generator, GitHub pages, and a custom domain name cover those points. Having a static site generator benefits in supporting the Markdown syntax, which I am using to write my notes. Plus, it is an additional technical challenge to configure and support that all by myself.

So my first choice was pretty obvious...