BelgIF-OpenAPI, een set libraries van gemeenschappelijke data types georganiseerd per domein, om een REST API te beschrijven en aldus te hergebruiken in OpenAPI (Swagger)-specificaties
U ontwikkelt een REST-service met identificatiegegevens van de sociale zekerheid (INSZ, ondernemingsnummer, enz.), datums, bedragen, landcodes, gewesten of gemeenten, enz. Verwijs dan eenvoudigweg naar de BelgIF OpenAPI-schemas in uw OpenAPI-document.
Een werkgroep, bestaande uit functionelen van FOD BOSA, eHealth, KSZ, FOD Financiën en Smals, heeft de meest gangbare bedrijfsontologieën (Person, Organization, Location, Temporal, Generic...) gestandaardiseerd.
Deze samenwerking resulteerde in
BelgIF-OpenAPI definieert data types in de volgende domeinen:
Alle types zijn beschikbaar in de OpenAPI 2.0 (Swagger) en OpenAPI 3.0 formaten.
Er kan vanuit andere OpenAPI-documenten naar de data types worden verwezen:
“$ref”: “./belgif/person/identifier/v1/person-identifier-v1.yaml#/components/schemas/Ssin”
Veelgebruikte OpenAPI-2.0 en 3.0-gegevenstypes worden onderhouden in de belgif openapi-* GitHub repositories, georganiseerd per domein. Typen met een bèta-status bevinden zich in de broncode, maar maken geen deel uit van de vrijgegeven artefacten. Apache Maven-gebruikers kunnen ze ook downloaden van Maven Central.
De libraries BelgIF-OpenAPI common data types kunnen gebruikt worden door iedereen die een REST API ontwikkelt, waarbij de interoperabiliteit tussen alle gebruikte API's wordt verbeterd.
Als je wenst bij te dragen door opmerkingen te formuleren over de standaarden, ze mee vorm te geven of er intern/extern over te communiceren, dan kan je een issue openen op het geschikte project (belgif-openapi, FedVoc, REST guide), of een mail sturen naar fsp@gcloud.belgium.be.
De libraries BelgIF-OpenAPI common data types zijn als open source gepubliceerd onder de licentie 2.0 van Apache en gratis te downloaden op GitHub of als maven-artifacts op Maven Central.
Contact: ReuseOperational@smals.be
Heb je een herbruikbare component die voor een andere instelling van pas kan komen?
Ideeën uitwisselen over hergebruik? Dat kan op onze evenementen. We organiseren er regelmatig!
Schrijf je in op onze nieuwsbrief en blijf op de hoogte van de laatste ontwikkelingen in hergebruik.
Is jouw project een succes geworden dankzij een hergebruikte component?