OpenAPI Specification

Property "Trefwoorden" has a restricted application area and cannot be used as annotation property by a user.

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 Alle eigenschappen

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.

• Status op lijst van Forum Standaardisatie: Verplicht (pas toe leg uit)

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

• https://www.forumstandaardisatie.nl/standaard/openapi-specification
• https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md
• Beheerorganisatie: OpenAPI Initiative
  • https://www.openapis.org/

    Gerelateerd

    SAML, OAuth

    Realiseert

    Lijst Open Standaarden voor Pas Toe of Leg Uit

Toepassing in voorzieningen en bouwstenen

Voorziening	Toelichting	Oordeel	Relevantie	Volgens bron	Gepubliceerd op
BRK (Basisregistratie Kadaster) BGT (Basisregistratie Grootschalige Topografie) WOZ (Basisregistratie Waarde Onroerende Zaken) BAG (Basisregistratie Adressen en Gebouwen)	Deze standaard is geïmplementeerd.	voldoet	van toepassing	Monitor Open Standaarden 2019	27 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).	voldoet	van toepassing	Monitor Open Standaarden 2019	27 maart 2020
BRV (Basisregistratie Voertuigen)	De BRV voldoet aan OpenAPI Specification.	voldoet	van toepassing	Monitor Open Standaarden 2019	27 maart 2020
HR (Basisregistratie Handelsregister)	KvK gebruikt deze specificatie actief. Reeds operationele API's worden geleidelijk aangepast.	voldoet deels	van toepassing	Monitor Open Standaarden 2020	11 februari 2021
MijnOverheid	Deze standaard wordt gebruikt voor de REST-API's van MijnOverheid.	voldoet	van toepassing	Monitor Open Standaarden 2020	11 februari 2021
Samenwerkende catalogi	Samenwerkende catalogi voldoet aan deze standaard.	voldoet	van toepassing	Monitor Open Standaarden 2020	11 februari 2021
Website RDW.nl	De BRV voldoet aan Open API Specification.	voldoet	van toepassing	Monitor Open Standaarden 2020	11 februari 2021
PDOK	Deze standaard is geïmplementeerd en wordt toegepast.	voldoet	van toepassing	Monitor Open Standaarden 2020	11 februari 2021
TenderNed	De 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 niet	van toepassing	Monitor Open Standaarden 2020	11 februari 2021

Toelichting: Bouwstenen en gebruikte standaarden