Dans DataService Studio, testez, publiez et utilisez des fonctions en tant que filtres pour traiter les requêtes et réponses d'API.
Prérequis
Assurez-vous d'avoir créé et enregistré la fonction. Pour plus d'informations, consultez la rubrique Gérer les fonctions.
Limites
Seuls le propriétaire de l'espace de travail et les utilisateurs RAM disposant du rôle Administrateur de l'espace de travail, Développeur ou Opérations et maintenance peuvent tester les fonctions. Pour plus d'informations, consultez la rubrique Ajouter un membre à un espace de travail et gérer les autorisations de rôle.
Étape 1 : Tester la fonction
-
Accédez à la page Data Services.
Connectez-vous à la console DataWorks. Dans la région cible, cliquez sur dans le volet de navigation de gauche. Sélectionnez un espace de travail dans la liste déroulante et cliquez sur Go to DataService Studio.
Sur la page Service Development, double-cliquez sur la fonction en cours de développement dans la liste des fonctions.
-
Sur la page de modification de la fonction, cliquez sur Test dans la barre d'outils supérieure.
## --- AviatorScript --- ## $0: the default name of the input param. ## Expressions must be separated by the semicolon ";". ## Example 1: ## $0.a: Get the attribute "a" from the input param "$0". ## $0.b[index]: Get the index of the array "b" from the input param "$0". The index cannot be an expression or a variable. ## Example 2: ## Input: {"keyA":[1,2],"keyB":"value"} ## Function: $0.keyA[0]=3; $0.keyB="new_value"; return $0; ## Output: {"keyA":[3,2],"keyB":"new_value"} -
Dans la boîte de dialogue Function Test, saisissez les paramètres et cliquez sur Confirm.
Consultez l'état d'exécution dans l'onglet Run Results en bas de la page. Si le test échoue, vérifiez le message d'erreur, modifiez la fonction et relancez le test.
Étape 2 : Publier la fonction
Une fois la fonction testée avec succès, publiez-la pour la rendre disponible.
Sur la page Service Development, double-cliquez sur la fonction qui a passé le test avec succès dans la liste des fonctions.
Dans la barre d'outils supérieure, cliquez sur Submission.
-
Sur la page de modification de la fonction, cliquez sur Version dans le volet de navigation de droite. Repérez la version dont le statut est Can Be Published et cliquez sur Publish dans la colonne Actions.
RemarqueAprès avoir publié la fonction, cliquez sur Version dans le volet de navigation de droite sur la page de modification de la fonction pour consulter l'historique des publications. Vous pouvez ensuite afficher les Version Details ou cliquer sur Roll Back.
Étape 3 : Utiliser la fonction
Cas d'utilisation
En tant que pré-filtre d'API, une fonction prétraite les paramètres de requête d'API lors d'un appel.
En tant que post-filtre d'API, une fonction traite et transforme la réponse de l'API.
Limites
Le pré-filtre et le post-filtre d'une API doivent utiliser le même type de fonction. Ils doivent tous deux être des fonctions Aviator ou tous deux des fonctions Python.
La fonctionnalité des fonctions Python est en cours de mise à niveau. La création, le clonage et la publication de nouvelles fonctions Python ne sont pas pris en charge.
Utiliser en tant que filtre d'API
Sur la page Service Development, développez .
Double-cliquez sur l'API pour ouvrir sa page de modification.
-
Dans le volet de navigation de droite, cliquez sur Filter.
Cochez la case Use Pre-filter ou Use Post-filter. Le Function Type est défini par défaut sur Aviator Function. Dans la liste déroulante du pré-filtre ou du post-filtre, sélectionnez une ou plusieurs fonctions. Si vous ajoutez plusieurs fonctions, elles s'exécutent dans l'ordre d'ajout.
RemarqueUn filtre se compose d'une ou plusieurs fonctions qui prétraitent les paramètres de requête d'API ou post-traitent les résultats de la requête.
Si vous ne trouvez pas la fonction cible dans la liste déroulante, assurez-vous que la fonction est publiée. Vous pouvez également créer et publier une nouvelle fonction. Pour plus d'informations, consultez la rubrique Publier la fonction.
Cliquez sur Preview Responses Returned by API Operation pour vérifier la sortie du filtre.