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)

Vous développez un service REST contenant des identifiants de la sécurité sociale (NISS, numéro d'entreprise, ...),  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.

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
• 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”

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

• Federal Service Platform - service GCloud
• Vocabulaire fédéral standard
• REST Guidelines
• Sources du REST Guidelines
• Schémas OpenAPI réutilisables
• Laissez une issue (= remarque, suggestion, question) sur le GitHub belgif-openapi approprié
• Présentation Federal Data & REST Standardization sur YouTube
• Standards européens - Terminologie fondamentale
• Standards interfédéraux de l'ICEG - revi
• Standards interfédéraux de l'ICEG (2)
• Standards régionaux
• Présentation (slides) Federal Data & REST Standardization

Contact

Contact : ReuseOperational@smals.be