REST API Design Rules

Inhoudsopgave

    Status

    Lijst status
    Verplicht (pas toe leg uit)
    Functioneel toepassingsgebied

    Beschrijft de toepassing(en) waarvoor het gebruik van de standaard verplicht is of aanbevolen wordt (afhankelijk van de lijststatus).

    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

    Benoemt de organisaties waarvoor de verplichting geldt.

    Nederlandse overheden (Rijk, provincies, gemeenten en waterschappen) en instellingen uit de (semi-) publieke sector.

    Europese status
    Nee

    Nut en werking

    Typering
    Set van regels op het gebied van naamgeving en het gebruik van parameters voor REST API’s.
    Nut

    De standaard REST API Design Rules schrijft een set van regels op het gebied van naamgeving en het gebruik van parameters voor waarmee de hele overheid op eenduidige manier REST API’s aanbiedt. Hiermee wordt bereikt dat de overheid op dit vlak voorspelbaar is, en ontwikkelaars makkelijk aan de slag kunnen en API’s kunnen consumeren en combineren, en niet geconfronteerd worden met verschillende, en dus niet samenhangende, manieren waarop REST API’s door de overheid aangeboden worden.

    Overheden die REST API’s aanbieden worden ontzorgd voor het generieke aspect van API’s aanbieden. Ze kunnen zich richten op de aspecten van API ontwerp waar hun data, informatie en functionaliteiten toegevoegde waarde bieden. 

     

    Werking

    Een application programming interface (API) is een gestructureerd en gedocumenteerd koppelvlak voor communicatie tussen applicaties. Je kan een API zien als een digitale stekkerdoos die applicaties met elkaar verbindt. Zo lang er computers zijn, bestaan er al 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.

    Bedrijven ontsluiten gegevens en applicaties tegenwoordig meestal online via REST API’s. Ontwikkelaars kunnen API’s bevragen vanuit alle veel gebruikte programmeertalen en frameworks, zoals Python, Java, Microsoft C#, PHP. Ook Nederlandse overheden passen REST API’s toe.

    De standaard REST API Design Rules schrijft een set van regels op het gebied van naamgeving en het gebruik van parameters voor waarmee de hele overheid op eenduidige manier REST API’s aanbiedt. 

    Domein
    Relatie met andere standaarden
    Relatie met andere standaarden
    Relatie met andere standaarden
    Trefwoorden

    Detailinformatie

    Volledige naam

    REST API Design Rules

    Versie
    1.0
    Specificatiedocument
    Beheerorganisatie
    Logius

    Toetsingsinformatie

    Uitstekend beheer
    Intakeadvies

    Intakeadvies_API_Design_Rules

    PDF Document | 210.52 KB
    12 maart 2020 (13:55)
    Expertadvies

    Expertadvies-standaard-REST-API-Design-Rules-1.0

    PDF Document | 420.3 KB
    12 maart 2020 (13:55)
    Commentaar uit de Openbare Consultatie

    Commentaar-uit-de-openbare-consultatie-REST-API-Design-Rules

    PDF Document | 166.27 KB
    02 juni 2020 (17:11)
    Forumadvies

    Forumadvies-REST-API-Design-Rules

    PDF Document | 216.35 KB
    02 juni 2020 (17:18)
    Datum van aanmelding

    15-10-2019

    Datum besluit

    09-07-2020

    Overig

    Toelichting bij opname

    De REST API Design Rules verplichten niet het gebruik van REST API's. REST API Design Rules stellen dat als je REST API's gebruikt, dan moet je de Design Rules toepassen.

    Adoptieadviezen

    De formele adoptieadviezen die het Forum Standaardisatie meegeeft bij plaatsing op de lijst open standaarden.

    • 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.
       
    • Aan Logius (beheerder Digikoppeling) om expliciet aandacht te geven aan de samenhang en transitie van Digikoppeling en REST API Design Rules.
       
    • Aan Logius als toekomstig 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.
       
    • Aan de Werkgroep API Design Rules van het Kennisplatform APIs om te werken aan verdere inhoudelijke ontwikkeling van de standaard om deze volwassener te maken en openstaande technische ‘issues’ weg te werken. Het Kennisplatform APIs heeft toegezegd hier zo snel mogelijk mee aan de slag te gaan.

    Contactgegevens Han Zuidweg

    Han Zuidweg

    Adviseur document-, content- en datastandaarden

    070 - 888 77 76

    +31 (0)6 46 1184 26