Nous utilisons des cookies sur ce site pour améliorer votre expérience utilisateur.

Skip to main content

Contenu

BelgIF OpenAPI common data types

Aperçu

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

Domaine

Services IT génériques

Sous-domaine

Software factory - non lié à la sécurité

Typologie

Library

Service owners

SPF Finances, Smals, BCSS, eHealth, BOSA, ONSS

Première release

2019

Réutilisation

plus que 30

Effort d'intégration

Quelle en est l'utilité ?

Vous développez un service REST contenant des identifiants de la sécurité sociale (NISS, numéro d'entreprise, ...), des soins de santé,  des dates, des montants, des codes pays, régions ou communes, ... alors référencez tout simplement les schémas BelgIF-OpenAPI dans votre document OpenAPI.

De plus, vous pouvez tester si votre document OpenAPI est conforme au Guidelines REST publiées sur BelgIF, en utilisant le plugin mis à votre disposition sur GitHub.

Description fonctionnelle

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 (Belgif OpenAPI schemas) conformes à cette terminologie Belgif et au Belgif REST guidelines 

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

  • organization-identifier
  • organization
  • employment-identifier
  • person-identifier
  • person
  • location
  • healthcare
  • 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”

Un plugin sur GitHub est également disponible permettant de valider que votre document OpenAPI est conforme au Guidelines REST publiées sur BelgIF.

Description technique

Les types de données fréquemment utilisées OpenAPI 2.0 et 3.0 sont conservées dans les répertoires belgif openapi-* GitHub, organisés par domaine. Les types en statut bêta sont dans le code source, mais ne font pas partie des artefacts publiés. Les utilisateurs d'Apache Maven peuvent également les télécharger depuis Maven Central.

Public cible

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 contribuer en commentant les standards, en aidant à les façonner ou en communiquant à leur sujet en interne/externe, vous pouvez ouvrir un ticket sur le projet approprié (belgif-openapi, FedVoc, REST guide), ou envoyez un e-mail à 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.

Documentation

Contact

Contact : ReuseOperational@smals.be

Faites partie de quelque chose de plus grand : rejoignez le mouvement ReUse

Complétez le catalogue

Communication, services métiers, services de support, services IT génériques; autant de domaines business que vous pouvez enrichir de vos composants réutilisables, utiles à d’autres institutions. Ils peuvent aussi concerner des matières que nous cherchons à développer comme les paiements, le reporting, les RH…

Plus d'information et formulaire

Devenez ambassadeur de la réutilisation !

Parcourez notre catalogue pour vous familiariser avec les composants réutilisables. Evoquez tout l’intérêt de ReUse auprès de vos employés et au sein de leurs réseaux.

Plus vous ferez la publicité du concept ReUse et enrichirez le catalogue, plus vous en renforcerez les avantages.

Suivez-nous !

Restez informé des derniers développements et événements ! Abonnez-vous à notre newsletter.

Consultez toutes nos newsletters

Vers le haut