BelgIF OpenAPI common data types

BelgIF-OpenAPI, un ensemble de librairies de types de données communes organisées par domaine, pour décrire une API REST et ainsi la réutiliser dans les spécifications OpenAPI (Swagger)

  • Library
  • Interfaces
  • SPF Finances Smals BCSS eHealth BOSA ONSS

Description

Un groupe de travail fonctionnel composé du SPF BOSA, d'eHealth, de la BCSS, du SPF Finances et de Smals a collaboré pour standardiser les ontologies business les plus courantes (Personne, Organisation, Lieu, Temps, Générique, etc).

Cette collaboration a abouti

  • d’une part, à la publication d’une liste terminologique (terminologie Belgif) composée de classes et de propriétés, avec leurs URI, acceptée par le gouvernement fédéral comme terminologie standard. Cette terminologie est issue de trois sources : institutions publiques fédérales, Flandre et normes UE et chaque élément de terminologie possède un identifiant numérique (sans signification), un nom (en anglais, camelCase) et une définition
  • d’autre part, à des librairies de types de données communes conformes à cette terminologie Belgif et au G-Cloud REST guide

BelgIF-OpenAPI définit des types de données dans les domaines suivants :

  • organization-identifier
  • employment-identifier
  • person-identifier
  • person
  • location
  • time
  • money
  • problem
  • common (common technical data types)

Tous les types sont disponibles dans les formats OpenAPI 2.0 (Swagger) et OpenAPI 3.0.

Les types de données peuvent être référencés à partir d'autres documents OpenAPI :

   “$ref”: “./belgif/person/identifier/v1/person-identifier-v1.yaml#/components/schemas/Ssin”

Groupes d'utilisateurs

Les librairies BelgIF-OpenAPI common data types peuvent être utilisés par quiconque développe une API REST, améliorant ainsi l'interopérabilité entre toutes les API utilisées.

Si vous souhaitez donner votre feed-back sur les standards, contribuer à leur élaboration ou communiquer en interne/externe à propos des standards, envoyez un email à fsp@gcloud.belgium.be.

Conditions d'intégration

Les librairies BelgIF-OpenAPI common data types sont publiées en open source sous la licence Apache 2.0 et sont disponibles gratuitement en téléchargement sur GitHub ou sous forme d'artefacts maven sur Maven Central.

Contact : ReuseOperational@smals.be

Documentation

Certains des liens ci-dessous pourraient ne pas fonctionner en raison de restrictions de sécurité.

Si vous voulez obtenir ces informations, prenez contact avec l’équipe responsable via l’adresse email spécifiée dans le paragraphe ci-dessus consacré aux conditions d’intégration.

Comment participer ?

Enrichir le catalogue

Vous avez un composant réutilisable qui pourrait intéresser d’autres institutions ? 

Proposez-le-nous !

Découvrez nos témoignages

 

Participer à nos évènements

Vous aimeriez échanger au sujet de la réutilisation ? Des évènements sont régulièrement organisés.

Inscrivez-vous ici !

Recevoir la newsletter

Inscrivez-vous à la newsletter pour suivre l’actualité autour de la réutilisation.

Inscrivez-vous ici !

Partager votre expérience

Réutiliser un composant vous a aidé à transformer un projet en réussite ?

Faites-nous part de votre expérience !

Découvrez nos témoignages

Vers le haut