OIP Features Library
CHANGELOG
Concepts clés
Une feature est une unité fonctionnelle réutilisable qui expose un ensemble d’APIs métier. Exemple uploadDocument downloadDocument deleteDocument Une feature est initialisée avec des options retourne un dictionnaire de fonctions chaque fonction traite un projectEntity retourne { projectEntity, metadata?
Conventions
suffixer chaque feature par Feature nommer les implémentations internes avec un préfixe $ si tu suis le pattern existant exposer des noms d’API explicites orientés métier une feature = un domaine fonctionnel une API = une action métier claire éviter les services trop génériques garder le contrat d’entrée/sortie homogène
Créer un service
Chaque fonction exposée par une feature doit suivre ce contrat Dans les exemples fournis, les services sont appelés avec un objet contenant On garde donc cette forme comme convention d’usage. Un service doit idéalement lire les données de args appeler le service externe si nécessaire mettre à jour projectEntity remonter l’état de task si applicable retourner { projectEntity, metadata?
Créer une feature
Le nom d’une feature doit être suffixé par Feature. Exemples DocumentFeature SignatureFeature SirenFeature Ce pattern est celui documenté dans le markdown source.
Features OIP
Configuration du service externe utilisé par la feature. Usage endpoint d’un service tiers authentification API Configuration de publication d’événements.
Getting Started
Messaging Integration
Une feature peut publier des événements RabbitMQ pendant son exécution via l’option rabbitmq .
Présentation
OIP Features est une librairie de features réutilisables pour mutualiser les développements standards entre plusieurs projets OIP. Une feature peut s’appuyer sur un ou plusieurs services externes.
Principes de conception
L’un des principes fondamentaux de OIP Features est que toutes les features doivent partager la même structure d’initialisation. Cette homogénéité permet de simplifier l’apprentissage de faciliter l’intégration d’éviter les implémentations ad hoc selon les projets de garantir une expérience développeur cohérente La feature travaille toujours à partir de l’entité Project, qui constitue l’objet central manipulé dans OIP.