Blogposts Floris over AsyncAPI#694
Conversation
|
Super-linter summary
All files and directories linted successfully For more information, see the Powered by Super-linter |
|
@Fdeutekom build faalt dit heb ik even gefixt. Daar lokaal altijd even |
Super-linter summary
All files and directories linted successfully For more information, see the Powered by Super-linter |
| ## 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 |
There was a problem hiding this comment.
| 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 |
There was a problem hiding this comment.
| [OpenAPI Initiative](https://www.openapis.org/), waarin door een toegeweid team | |
| [OpenAPI Initiative](https://www.openapis.org/), waarin door een toegewijd team |
There was a problem hiding this comment.
Misschien ook doorlinken naar https://developer.overheid.nl/kennisbank/api-ontwikkeling/standaarden/openapi-specification/?
|
|
||
| ## Vingers aan de knoppen | ||
|
|
||
| Om beter grip op de nuances te krijgen hebben we bestaande een reeks |
There was a problem hiding this comment.
| 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 |
There was a problem hiding this comment.
| 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] | |||
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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) |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
| 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 |
There was a problem hiding this comment.
| [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>
Super-linter summary
All files and directories linted successfully For more information, see the Powered by Super-linter |
Drie posts, online te zetten in volgorde (en wellicht uitgesmeerd over drie dagen ofzo).
Nog inhoudelijke en vormtechnische reviews op nodig, voorlopig in Draft