Skip to content

Blogposts Floris over AsyncAPI#694

Open
Fdeutekom wants to merge 3 commits into
mainfrom
Blogposts-Floris
Open

Blogposts Floris over AsyncAPI#694
Fdeutekom wants to merge 3 commits into
mainfrom
Blogposts-Floris

Conversation

@Fdeutekom
Copy link
Copy Markdown
Contributor

Drie posts, online te zetten in volgorde (en wellicht uitgesmeerd over drie dagen ofzo).

Nog inhoudelijke en vormtechnische reviews op nodig, voorlopig in Draft

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Apr 28, 2026

⚠️ No Changeset found

Latest commit: 3904347

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions
Copy link
Copy Markdown
Contributor

Super-linter summary

Language Validation result
JSON Pass ✅
OPENAPI Pass ✅

All files and directories linted successfully

For more information, see the
GitHub Actions workflow run

Powered by Super-linter

@pasibun
Copy link
Copy Markdown
Contributor

pasibun commented Apr 28, 2026

@Fdeutekom build faalt dit heb ik even gefixt. Daar lokaal altijd even pnpm i && pnpm build

@github-actions
Copy link
Copy Markdown
Contributor

Super-linter summary

Language Validation result
JSON Pass ✅
OPENAPI Pass ✅

All files and directories linted successfully

For more information, see the
GitHub Actions workflow run

Powered by Super-linter

Comment thread blog/draft/asyncapi-1-tot-nu-toe.md Outdated
## AsyncAPI

Maar eerst even wat achtergrond en introductie voor wie nog niet bekend is met
AsyncAPI. In het kort, AsyncAPI is een open source set aan standaarden tools
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
AsyncAPI. In het kort, AsyncAPI is een open source set aan standaarden tools
AsyncAPI. In het kort, AsyncAPI is een open source set aan standaarden en tools

voor ontwikkelen en documenteren van asynchrone API’s en
[Event-Driven Architecture](https://developer.overheid.nl/blog/2026/03/06/event-driven)
in zijn algemeen. Het is tevens een voortborduursel op het werk van
[OpenAPI Initiative](https://www.openapis.org/), waarin door een toegeweid team
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[OpenAPI Initiative](https://www.openapis.org/), waarin door een toegeweid team
[OpenAPI Initiative](https://www.openapis.org/), waarin door een toegewijd team

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


## Vingers aan de knoppen

Om beter grip op de nuances te krijgen hebben we bestaande een reeks
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Om beter grip op de nuances te krijgen hebben we bestaande een reeks
Om beter grip op de nuances te krijgen hebben we een bestaande reeks

een sterke externe afhankelijkheid in; denk hierin aan de black-box nature van
de default templates, versies van tooling en het gekozen perspectief binnen de
specificatie. In één geval bleek bijvoorbeeld dat om een bepaald type code te
generen de documentatie naar een lagere versie gebracht moest worden, maar dat
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
generen de documentatie naar een lagere versie gebracht moest worden, maar dat
genereren de documentatie naar een lagere versie gebracht moest worden, maar dat

@@ -0,0 +1,187 @@
---
authors: [floris-deutekom]
tags: [api, api-design, asyncapi, eda]
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Artikelen zouden nog voorzien kunnen worden van een afbeelding.

# AsyncAPI: verkenning en eerste bevindingen

De afgelopen periode hebben we binnen developer.overheid.nl samen met de
Werkgroep AsyncAPI geëxperimenteerd met het toepassen van AsyncAPI in een aantal
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Niet iedereen zal bekend zijn met de "Werkgroep AsyncAPI".

Om beter grip op de nuances te krijgen hebben we bestaande een reeks
API-specificaties waarin al sprake was van asynchrone communicatie omgezet naar
een AsyncAPI documentatie; zie
[hier](https://studio.asyncapi.com/?share=d36cdf7f-1b42-4ac9-98a9-3194912fbfa0)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Blijven deze links oneindig beschikbaar? Misschien hebben we hiervoor een andere plek nodig?

communicatie, asynchroon of anderszins. Juist door kritisch te kijken naar de
aard van het probleem en de context waarin het zich voordoet, kun je bepalen of
de inzet van AsyncAPI daadwerkelijk bijdraagt aan een betere oplossing. We zijn
nog niet zover, maar het begint er wel op te lijken dat een NLgov profiel op den
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
nog niet zover, maar het begint er wel op te lijken dat een NLgov profiel op den
nog niet zover, maar het begint er wel op te lijken dat een NL GOV profiel op den

[CloudEvents](https://cloudevents.io/) vangt precies dat probleem af door een
minimale, duidelijke standaard neer te zetten voor event-metadata en het
beschrijven/definiëren van het event zelf. Opgenomen als
[NLgov profiel](/kennisbank/api-ontwikkeling/standaarden/cloudevents) en door
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[NLgov profiel](/kennisbank/api-ontwikkeling/standaarden/cloudevents) en door
[NL GOV profiel](/kennisbank/api-ontwikkeling/standaarden/cloudevents) en door

Co-authored-by: Joost Farla <joostfarla@users.noreply.github.com>
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 8, 2026

Super-linter summary

Language Validation result
JSON Pass ✅
OPENAPI Pass ✅

All files and directories linted successfully

For more information, see the
GitHub Actions workflow run

Powered by Super-linter

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Review

Development

Successfully merging this pull request may close these issues.

3 participants