OpenAPI Specification

Uit NORA Online
Ga naar: navigatie, zoeken



Standaard.png
Naam: OpenAPI Specification

ID: OpenAPI Specification

Type: Standaard
Versie: 3.0
Sjabloon:Titel laag0, 1
Deze informatie is (deels) overgenomen van forumstandaardisatie.nl.
Schaduwkopie: FS:OpenAPI Specification

Status actualiteit: Actueel [1]

Publicatie van REST APIs
Publicatie van REST APIs, OpenAPI Specification (OAS) 3.0 is een standaard waarmee REST APIs op een uniforme, machineleesbare en implementatieonafhankelijke manier kunnen worden beschreven in JSON-formaat.  OAS geeft gebruikers een eenduidige en leesbare beschrijving van een REST API waarmee zij de interface zonder specifieke implementaties of software kunnen gebruiken.
OAS 3.0 zorgt er bovendien voor dat ontwikkelaars op een uniforme en inzichtelijke manier kunnen beschrijven wat een API doet, dat er minder leveranciersafhankelijkheid ontstaat en dat overheden meer hergebruik kunnen maken van elkaars ervaringen met betrekking implementatie van REST API’s.


  • Nut: OpenAPI Specification (OAS) 3.0 is een standaard waarmee REST APIs op een uniforme, machineleesbare en implementatieonafhankelijke manier kunnen worden beschreven in JSON-formaat.  OAS geeft gebruikers een eenduidige en leesbare beschrijving van een REST API waarmee zij de interface zonder specifieke implementaties of software kunnen gebruiken.

OAS 3.0 zorgt er bovendien voor dat ontwikkelaars op een uniforme en inzichtelijke manier kunnen beschrijven wat een API doet, dat er minder leveranciersafhankelijkheid ontstaat en dat overheden meer hergebruik kunnen maken van elkaars ervaringen met betrekking implementatie van REST API’s.



Waar toepasbaar

  • Functioneel toepassingsgebied: OAS moet worden toegepast op het beschrijven/specificeren van een REST API.
  • Organisatorisch werkingsgebied: Nederlandse overheden (Rijk, provincies, gemeenten en waterschappen) en instellingen uit de (semi-) publieke sector.
  • Waarvoor geldt de verplichting: OAS moet worden toegepast op het beschrijven/specificeren van een REST API.

Meer informatie

Toepassing in voorzieningen en bouwstenen

VoorzieningToelichtingOordeelRelevantieVolgens bronGepubliceerd op
BRK (Basisregistratie Kadaster)
BGT (Basisregistratie Grootschalige Topografie)
WOZ (Basisregistratie Waarde Onroerende Zaken)
BAG (Basisregistratie Adressen en Gebouwen)
Deze standaard is geïmplementeerd.voldoetvan toepassingMonitor Open Standaarden 201927 maart 2020
BRO (Basisregistratie Ondergrond)Het Bronhouderportaal BRO (voorportaal voor validatie van BRO gegevens voordat deze worden door geleverd naar de Landelijke Voorziening BRO) voldoet aan de open API specificatie https://www.bronhouderportaal-bro.nl/bpbro-frontend/documentation/api.html. De Landelijke Voorziening BRO voldoet aan de PTOLU Digikoppeling standaard (SOAP-XML).voldoetvan toepassingMonitor Open Standaarden 201927 maart 2020
BRV (Basisregistratie Voertuigen)De BRV voldoet aan OpenAPI Specification.voldoetvan toepassingMonitor Open Standaarden 201927 maart 2020
HR (Basisregistratie Handelsregister)KvK gebruikt deze specificatie actief. Reeds operationele API's worden geleidelijk aangepast.voldoet deelsvan toepassingMonitor Open Standaarden 202011 februari 2021
MijnOverheidDeze standaard wordt gebruikt voor de REST-API's van MijnOverheid.voldoetvan toepassingMonitor Open Standaarden 202011 februari 2021
Samenwerkende catalogiSamenwerkende catalogi voldoet aan deze standaard.voldoetvan toepassingMonitor Open Standaarden 202011 februari 2021
Website RDW.nlDe BRV voldoet aan Open API Specification.voldoetvan toepassingMonitor Open Standaarden 202011 februari 2021
PDOKDeze standaard is geïmplementeerd en wordt toegepast.voldoetvan toepassingMonitor Open Standaarden 202011 februari 2021
TenderNedDe publieke API's worden beschreven door middel van Swagger. Swagger kan je zien als OAS versie 2.0. Swagger als API Specificatie bestaat niet meer en is opgegaan in OAS. TenderNed voldoet daarmee niet aan OAS 3.0. Deze versie is belangrijk omdat deze samenhang aanbrengt in de verschillende manieren om API specificaties op te stellen.voldoet nietvan toepassingMonitor Open Standaarden 202011 februari 2021

Toelichting: Bouwstenen en gebruikte standaarden

  1. Afgeleid van Status bij Forum Standaardisatie: (Verplicht (pas toe leg uit))