Skip to content

Commit f253339

Browse files
authored
Improvements blog floris (#755)
* fix: update blog Floris * fix: add changeset * fix: typo fix
1 parent 2406d39 commit f253339

2 files changed

Lines changed: 26 additions & 0 deletions

File tree

.changeset/fast-beans-help.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@developer-overheid-nl/website": patch
3+
---
4+
5+
TL;DR + kopjes toegevoegd aan blog Floris

blog/2026/05/28-asyncapi-1-tot-nu-toe.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,19 @@ is er een NLGov profiel nodig?” Met dit in het achterhoofd is een tweetal case
3535
opgepakt en zijn we de diepte ingedoken, met regelmatige besprekingen in de
3636
werkgroep.
3737

38+
:::success[TL;DR]
39+
40+
De Werkgroep AsyncAPI heeft concrete cases uitgewerkt om te toetsen of AsyncAPI
41+
een standaard moet worden voor de Nederlandse overheid. De technische werking is
42+
bewezen: conversie van bestaande API-documentatie is goed te doen en de tooling
43+
is volwassen. Maar AsyncAPI voegt pas écht waarde toe in een volwaardig
44+
Event-Driven landschap, niet bij een simpele 1-op-1 conversie van bestaande
45+
OpenAPI-specs. De kern­vraag: moet de standaard as-is worden opgenomen of met
46+
een NLGov-profiel. Deze vraag staat nog open en komt in volgende blogposts aan
47+
bod.
48+
49+
:::
50+
3851
## AsyncAPI
3952

4053
Maar eerst even wat achtergrond en introductie voor wie nog niet bekend is met
@@ -77,6 +90,8 @@ gewoon ondersteund in OAS.
7790

7891
## Vingers aan de knoppen
7992

93+
### 1-op-1 conversie
94+
8095
Om beter grip op de nuances te krijgen hebben we een bestaande reeks
8196
API-specificaties waarin al sprake was van asynchrone communicatie omgezet naar
8297
een AsyncAPI documentatie; zie
@@ -108,6 +123,8 @@ explicieter gemaakt, maar de onderliggende architectuur bleef ongewijzigd.
108123
Daarmee ontstaat een situatie waarin je wel asynchrone documentatie hebt, maar
109124
nog geen Event-Driven ontwerp. Kortom, we kunnen nog een stap verder.
110125

126+
### Event-Driven herontwerp
127+
111128
Voor één van de casussen hebben we dus precies dit gedaan; in plaats van een
112129
simpele conversie is er een volledig Event-Driven documentatie in AsyncAPI
113130
opgeschreven. Waar de 1-op-1 conversie nog sterk leunde op bestaande endpoints
@@ -168,6 +185,8 @@ misinterpretaties te voorkomen. Hetzelfde geldt voor bredere Event-Driven
168185
landschappen, waarin inzicht in de keten en de impact van wijzigingen cruciaal
169186
is om het geheel beheersbaar te houden.
170187

188+
### Wanneer AsyncAPI minder waarde toevoegt
189+
171190
Daar tegenover staan situaties waarin die meerwaarde een stuk minder evident is.
172191
In eenvoudige koppelingen tussen twee systemen, zeker wanneer beide onder
173192
dezelfde verantwoordelijkheid vallen, voegt het expliciet modelleren van events
@@ -178,6 +197,8 @@ tooling zwaarder wegen dan de voordelen die het oplevert. Sterker nog, wanneer
178197
documentatie niet actief wordt bijgehouden, kan het zelfs een risico vormen
179198
doordat het een vertekend beeld geeft van de werkelijkheid.
180199

200+
## Conclusie
201+
181202
De belangrijkste les die uit deze exercitie naar voren komt, is dan ook dat
182203
AsyncAPI vooral gezien moet worden als een middel, en niet als een doel op zich.
183204
Het is een krachtig instrument om asynchrone communicatie inzichtelijk te maken,

0 commit comments

Comments
 (0)