Les filtres d'API permettent d'associer une logique personnalisée à une API sans en modifier l'implémentation principale. Un préfiltre s'exécute avant le traitement de la requête entrante par l'API ; il permet de reformater les paramètres, de valider les données d'entrée ou d'injecter un contexte. Un post-filtre s'exécute après le renvoi des résultats par l'API ; il permet de transformer, d'enrichir ou de masquer la réponse.
Fonctionnement des filtres d'API
DataService Studio prend en charge les fonctions Aviator et Python. Utilisez DataService Studio pour créer des fonctions, tester, publier et utiliser des fonctions, ainsi que pour publier des fonctions. Une fois la fonction publiée, associez-la à une API pour l'utiliser comme filtre. Cette approche permet de gérer différentes exigences de requête et de s'adapter aux scénarios métier sans modifier la logique principale de l'API. Pour plus d'informations, consultez la rubrique Utiliser une fonction comme filtre d'API.
Un préfiltre traite les paramètres de requête d'une API avant que celle-ci ne gère l'appel.
Un post-filtre transforme les résultats renvoyés par une API après le traitement de l'appel.
Pour des exemples de code illustrant des scénarios courants, consultez la rubrique Bonnes pratiques : Utiliser une fonction Aviator comme filtre.
Prérequis
Le préfiltre et le post-filtre d'une API doivent utiliser le même type de fonction : soit tous deux Aviator, soit tous deux Python. Le mélange de types de fonctions pour le préfiltre et le post-filtre d'une même API n'est pas pris en charge.
-
Pour des raisons de sécurité et de performance, les fonctions Aviator doivent s'exécuter dans un groupe de ressources exclusif pour DataService Studio.
Lors de la modification ou du test d'une fonction, attachez-y un groupe de ressources exclusif pour DataService Studio. Pour plus d'informations, consultez la rubrique Créer une fonction.
Lors du développement d'une API, si vous activez un filtre et associez une fonction cible, attachez un groupe de ressources exclusif pour DataService Studio à l'API. Pour plus d'informations, consultez la rubrique Générer une API dans l'interface sans code.
Limites
La fonctionnalité de filtre nécessite DataWorks Basic Edition ou une version ultérieure.
Les fonctions Python sont en cours de mise à niveau. Vous ne pouvez pas créer, cloner ni publier de nouvelles fonctions Python. Utilisez plutôt le type de fonction Aviator. Pour plus d'informations, consultez la rubrique Créer une fonction Aviator.