OpenAPI Specification
Uit NORA Online
 ID: OpenAPI Specification Type: Standaard Versie: 3.0 Deze informatie is (deels) overgenomen van forumstandaardisatie.nl
|
Publicatie van REST APIs
- 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 toepassingsgebiedDe omschrijving van het functionele gebruik van de voorziening: OAS moet worden toegepast op het beschrijven/specificeren van een REST API.
- Organisatorisch werkingsgebiedHet domein (organisatorisch, taakvelden) binnen de overheid waarin het element (principe, standaard, voorziening..) wordt of kan worden toegepast. Bijvoorbeeld: gemeenten, provincies, waterschappen, Rijk, zorginstellingen, primair onderwijs.: 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
