Bewerken pagina: FS:Rest-api-design-rules
FS:Rest-api-design-rules
Naar navigatie springen
Naar zoeken springen
U hebt geen toestemming om deze pagina te bewerken, want:
De gevraagde handeling is voorbehouden aan gebruikers in een van de volgende groepen:
gebruikers
,
beheerders
, projectlid, secretaris.
U hebt geen rechten om de gevraagde handeling te verrichten.
Vul in dit formulier alle gegevens in van de standaard. Kies de (eventueel verkorte) naam van de standaard als paginanaam.
Elementtype
*
Het elementtype waaronder deze pagina valt. U kunt dit niet wijzigen omdat het formulier is afgestemd op het elementtype.
:
Titel
Wordt weergegeven titel van de pagina (zo lang de pagina in de standaard naamruimte staat). Bijzondere eigenschap, wordt gebruikt door de extensie "Semantic Title"
:
Introductie
Samenvatting die bovenaan de pagina staat
:
REST-API design rules is een lijst afspraken die ontwikkelaars volgen tijdens het bouwen van een REST-API voor de publieke sector. Door de regels te hanteren wordt de API voorspelbaar. En dat is wel zo prettig voor andere ontwikkelaars die er gebruik van willen maken. Dankzij deze regels blijft het makkelijk voor organisaties om gegevens met elkaar uit te wisselen.
Status lijst Forum Standaardisatie
:
Archief
In behandeling
Aanbevolen
Verplicht (pas toe leg uit)
Functioneel toepassingsgebied
Beschrijf in welk functioneel gebied deze standaard toegepast dient te worden. Let wel, wijzigen van functioneel toepassingsgebied vindt alleen plaats als uitkomst van een toetsingsprocedure
:
De standaard REST-API Design Rules moet worden toegepast bij het aanbieden van REST API’s ten behoeve van het ontsluiten van overheidsinformatie en/of functionaliteit.
Organisatorisch werkingsgebied
Het organisatorische terrein waarbinnen de standaard van werking is. Let wel, wijzigen van functioneel toepassingsgebied vindt alleen plaats als uitkomst van een toetsingsprocedure
:
Omschrijving
Beschrijving in één regel waar iets voor dient
:
Nut
Bijdrage aan interoperabiliteit
:
De overheid ontsluit gegevens en applicaties steeds vaker met REST-API's. Voorbeelden hiervan zijn te zien op de website [https://developer.overheid.nl/ developer.overheid.nl], [https://commonground.nl/ in Common Ground], [https://www.vngrealisatie.nl/producten/haal-centraal Haal Centraal] en het [https://aandeslagmetdeomgevingswet.nl/ Digitaal Stelsel Omgevingswet]. Representational state transfer (REST) is een ontwerpprincipe dat wereldwijd veel gebruikt wordt voor het bouwen van programmeerinterfaces over het web (API's). REST is geen standaard maar een ontwerpprincipe, en laat nog veel vrijheid in het structureren van API's. De standaard REST-API Design Rules geeft een verzameling basisregels voor structuur en naamgeving waarmee de overheid op een uniforme en eenduidige manier REST-API's aanbiedt. Dit maakt het voor ontwikkelaars gemakkelijker om betrouwbare applicaties met te ontwikkelen met API's van de overheid.
Werking
Werking van de standaard: wat doet het?
:
Een application programming interface (API) is een gestructureerd en gedocumenteerd koppelvlak voor communicatie tussen applicaties. Zo lang er computers zijn, bestaan er API's en worden er verschillende API technologieën gebruikt. In de laatste 10 jaar heeft Representational state transfer (REST) zich ontwikkeld tot een bepalend principe voor het realiseren van API's. Zogenaamde ‘''REST-API's''’ doen voor applicaties wat websites voor mensen doen. Websites presenteren informatie aan mensen, REST-API's maken applicaties en gegevens over het Internet beschikbaar voor andere applicaties. De technologie achter websites en REST-API's heeft daarom veel gemeen. De overheid gebruikt REST-API's voor koppelingen met andere overheden, bedrijven en indirect ook met burgers, bijvoorbeeld via mobiele apps en webapps die aangeboden worden door bedrijven of overheden zelf. Ontwikkelaars kunnen deze REST-API's bevragen vanuit de gangbare programmeertalen en frameworks zoals Python, Java, Microsoft C#, PHP. De standaard REST-API Design Rules heeft tot doel om meer uniformiteit te brengen in de manier waarop de overheid REST-API's aanbiedt. Hiervoor beschrijft de standaard een aantal basisregels voor het structureren en documenteren van REST-API's. De REST-API Design Rules moeten toegepast worden daar waar de overheid REST-API's inzet, maar '''verplicht niet het gebruik van REST-API's''' bij het ontsluiten van gegevens of functionaliteit.
Domein Forum Standaardisatie
Indeling in domeinen zoals gehanteerd door Forum Standaardisatie
:
Trefwoorden Forum Standaardisatie
:
Informatiebeveiliging
Community
Organisaties waar men terecht kan voor adoptieondersteuning, best practices, use cases en informatie over de standaard.
:
Toelichting bij opname lijst Forum Standaardisatie
:
=== De standaard verplicht niet het gebruik van REST-API's === Als een overheidsorganisatie investeert in de bouw van REST-API's, dan moeten deze worden aangeboden worden volgens de REST-API design rules. De standaard zelf verplicht echter niet het gebruik van REST-API's om gegevens of functionaliteit te ontsluiten. Hiervoor kunnen als vanouds ook Webservices (SOAP-API's), (linked) open data of andere koppelvlakken gebruikt worden. === Beheer onder Logius === De standaard REST-API Design Rules is ontwikkeld in het [https://www.geonovum.nl/themas/kennisplatform-apis Kennisplatform API's] door een brede groep organisaties. Vanaf medio 2020 ligt het beheer van de standaard formeel bij [https://www.logius.nl/diensten-van-logius/standaarden Logius]. Het Kennisplatform API's blijft wel input leveren voor de doorontwikkeling van de standaard. === Veranderend gegevenslandschap === De groeiende inzet van REST-API's bij de overheid raakt bestaande standaarden zoals [https://forumstandaardisatie.nl/open-standaarden/digikoppeling Digikoppeling] en [https://forumstandaardisatie.nl/open-standaarden/stuf StUF]. Logius, VNG, Forum Standaardisatie en het Kennisplatform API's werken samen aan een visie over de transitie naar een nieuw gegevenslandschap en hoe REST-API's, Digikoppeling en StUF daarin samenhangen. Hierover volgt nog een publicatie.
Uitstekend beheer
Indicatie of het beheer voldoet aan de door het Forum Standaardisatie gestelde normen voor uitstekend beheer
:
Geen/onbekend
Ja
Nee
Nog niet getoetst
Datum van aanmelding lijst Forum Standaardisatie
Datum waarop een organisatie de standaard heeft aangemeld voor opname op de lijst van aanbevolen of verplichte open standaarden. Als een standaard voldoet aan de criteria om in behandeling genomen te worden, vindt een toetsingsprocedure plaats. Deze duurt ongeveer een 6 maanden.
:
Datum van besluit lijst Forum Standaardisatie
:
Volledige naam
De volledige naam (afkortingen uitgeschreven)
:
Versie
Versie van de standaard(en) die door het Bureau Forum Standaardisatie is opgenomen
:
Specificatiedocument
Links naar de specificatiedocument(en) van deze versie van de standaard
:
https://publicatie.centrumvoorstandaarden.nl/api/adr/
Beheerorganisatie
Beheerorganisatie
:
Aandachtspunten
Beschrijf de eventuele aandachtspunten voor toepassing van de standaard.
:
Aanvullende verplichtingen
Beschrijf eventuele aanvullende verplichtingen bij toepassing van deze standaard.
:
Adoptieadviezen
Adviezen vanuit het Forum Standaardisatie aan diverse betrokkenen om de adoptie van de standaard te bevorderen.
:
* Aan Forum Standaardisatie om duidelijkheid te geven over de samenhang tussen verschillende standaarden –met name de samenhang tussen StUF en standaarden gerelateerd aan API’s– eventueel door het publiceren van een beslisboom.<br /> * Aan Logius (beheerder Digikoppeling) om expliciet aandacht te geven aan de samenhang en transitie van Digikoppeling en REST API Design Rules.<br /> * Aan Logius als beheerorganisatie om te waken voor een evenredige vertegenwoordiging van verschillende disciplines (zoals ontwikkelaars, ontwerpers, architecten en beleidsmakers) in de werkgroep bij het ontwikkel- en beheerproces van de standaard.<br /> * Aan de Werkgroep API Design Rules van het Kennisplatform API's om te werken aan verdere inhoudelijke ontwikkeling van de standaard om deze volwassener te maken en openstaande technische ‘issues’ weg te werken. Het Kennisplatform API's heeft toegezegd hier zo snel mogelijk mee aan de slag te gaan.
Advies aan beheerder
Advies van de expert die de opname begeleidde aan de beheerder van de standaard.
:
CPV-code
categorie-code voor inkoop
:
Conformiteitstest
Hoe te controleren of een systeem/dienst voldoet aan de standaard
:
Indiener
:
Leveranciers
:
Melding bovenaan pagina
:
Opgenomen op Europese lijst MSP
*
:
Ja
Nee
Praktijkvoorbeelden
Tijdelijk veld totdat er 'Praktijkvoorbeelden' als proxy-element zijn die praktijkvoorbeelden koppelen met meerdere standaarden
:
* '''Kadaster:''' [https://www.forumstandaardisatie.nl/node/990/ Kadaster Dataplatform, het platform met betrouwbare geodata]
Sjabloon-bestektekst
Voorbeeld bestektekst om de standaard te eisen bij inkoop
:
Toelichting relatie met andere FS-standaarden
:
Waarvoor geldt de verplichting
Uitleg voor welke groepen of organisaties de verplichting wel en niet geldt
:
Implementatiehulpmiddelen
:
Video
Informatie over de video
:
Status toelichting
Leg hier uit waarom de pagina niet 'actueel' is, bijvoorbeeld waar het door is vervangen of wanneer het is vervallen. Leg ook links naar RFC's et cetera.
:
Status historie
per bulletpoint (regel beginnend met spatie) op welke datum, welke beheer-handeling is begonnen. met eventueel daarachter een toelichting.
:
Concept-pagina FS
*
als dit 'Ja' is, wordt de pagina niet gepubliceerd als RDF en wordt de pagina niet in bepaalde overzichten getoond.
:
Ja
Nee
Relatie met andere FS-standaarden
Toegestaan zijn (door komma's gescheiden) elementen van de volgende typen: FS-Standaard
:
Digikoppeling (FS:Digikoppeling)
NL GOV Assurance profile for OAuth 2.0 (FS:Nl-gov-assurance-profile-oauth-20)
OData (FS:Odata)
OpenAPI Specification (FS:Openapi-specification)
Vrije tekst
U kunt hier extra informatie toevoegen. Deze zal onderaan de pagina getoond worden, maar is niet opvraagbaar via query's.
:
Meta-informatie
Samenvatting bewerking
U kunt hier een samenvatting of reden van de bewerking opgeven.
:
Samenvatting:
Dit is een kleine wijziging
Volg deze pagina
Pagina opslaan
Bewerking ter controle bekijken
Wijzigingen bekijken
Annuleren
Navigatiemenu
Persoonlijke hulpmiddelen
Account aanmaken
Aanmelden
Naamruimten
FS
Overleg
Nederlands
Weergaven
Lezen
Formulier bekijken
Geschiedenis weergeven
Meer
Pagina exporteren
Zoeken
Navigatie
NORA
Nieuws & Agenda
Laatste wijzigingen
Blijf op de hoogte
Hulp & contact
Ecosysteem
NORA Familie
GDI Architectuur
Architectuurafspraken
Overzicht
Kernwaarden
Kwaliteitsdoelen
Architectuurprincipes
Implicaties
Wijzigingen 1-1-2023
Lijsten & Verwijzingen
Beleidskaders
Standaarden
Bouwstenen
Begrippen
Architecturen
Gegevens-woordenboeken
Thema's
Overzicht
Beveiliging
Basisconcept van Dienstverlening
AI & Algoritmen
API
Data op het web
Duurzame Toegankelijkheid
Gegevensmanagement
Geo
IAM
Internationaal
Ketensturing
Mobiele apps
Privacy
Basisregistraties
Zaakgericht Werken
Overige onderwerpen
Vakmanschap
NORA-Instrumenten
PSA
NORA Review
NORA Vijflaagsmodel
Domeinen
Opleidingen
Community beginners
Visualisatie
Over NORA
Overzicht
NORA Beheer
NORA Gebruikersraad
Wijzigingsproces
Jaarplan
Kennismodel
Compliancy & Verantwoording
Hulpmiddelen
Verwijzingen naar deze pagina
Gerelateerde wijzigingen
Speciale pagina's