VNG-Realisatie / api-beheer

Repository met beschrijving van het beheer van (ZGW) API specificaties
2 stars 0 forks source link

Concept tekst beheerlandschap #144

Closed melsk-r closed 5 years ago

michielverhoef commented 5 years ago

Dit stuk gaat vooral over de scope van beheer toch? Hoe test.developer.overheid.nl daar in past kan ik niet aangeven.

developer.overheid.nl moet het portaal worden waar ontwikkelaars informatie kunnen vinden over alle API's die in overheidsland gebruikt worden.

Het is een publicatie mechanisme waar de ZGW API's (en straks andere API's) in ieder geval goed aangemeld moeten staan. Voor de rest verwacht ik niet dat wij developer.overheid.nl gaan beheren.

.. knip ..

Niet alle API ontsluiten registraties, dus ik vind registratie component niet dekkend. Ik spreek liever over API's wat ook tegemoet komt aan Squad/Team/Kenniscentrum/Expertisecentrum Architectuur die vond dat de ZGW componenten... anyway.

Dit is toch een lastige. Wanneer we de definitie van API hanteren zoals hierboven beschreven ontsluiten API's gegevens die in bronnen geregistreerd staan. De API wordt dus geboden door een registratie component. Wat het lastiger maakt is dat de referentiecomponenten ook gedrag vertonen. Bijvoorbeeld de DRC die bij het aanmaken van een relatie tussen een informatieobject en een zaak deze relatie ook in de ZRC aanmaakt door een zaakinformatieobject aan te maken.

Ongetwijfeld bestaan er ook API's die functionaliteit ontsluiten. Bijvoorbeeld het genereren van documenten.

Volgens mij moet de definitie van API dan iets worden als: API -- Application Programming Interface Service om informatie van een bron of functionaliteit van een systeem te ontsluiten. Typische voorbeelden: Zaken API, Documenten API, Autorisatie API, Documentcreatie API etc.

melsk-r commented 5 years ago

Dit stuk gaat vooral over de scope van beheer toch? Hoe test.developer.overheid.nl daar in past kan ik niet aangeven.

Ik zie wat naamgeving wirwar, wellicht beginnen met een definitie-lijst en deze termen consequent gebruiken

Deze hadden we al, zie ' api-beheer/begrippenlijst.md'.