Extraire

Utilisez la stratégie Extraire pour extraire et transformer les données des zones du contexte d'API.

Avant de commencer

Tableau 1. Passerelles prenant en charge cette politique et les versions correspondantes de celle-ci
Passerelle	Version de la stratégie
DataPower® API Gateway	2.0.0

Draft comment: slaflamm@us.ibm.com
Need to verify available versions.

Cette rubrique explique comment configurer la stratégie dans l'éditeur d'assemblage. Pour plus d'informations sur la configuration de la stratégie dans votre source « OpenAPI », consultez la section « extract ».

A propos de cette tâche

La règle Extraire spécifie la source de données qui contient le contenu à transformer, les zones qui contiennent le contenu et les expressions qui définissent comment transformer le contenu. Vous utilisez un sous-ensemble de notation JSONata pour spécifier les zones à extraire et transformer. Pour plus d'informations, consultez la section « Création d'expressions JSONata pour extraire et transformer des données ».

L'entrée de la stratégie Extract doit être des données analysées. Une façon de produire des données analysées consiste à ajouter une stratégie Analyse avant la stratégie Extraire dans votre assemblage.

Procédure

Dans le volet de navigation, cliquez sur « Développement », puis sélectionnez l'onglet « API ».
La page Développement s'ouvre.
Cliquez sur le titre de la définition d'API à utiliser.
Sélectionnez l'onglet Passerelle , puis cliquez sur Stratégies dans le panneau de navigation.
Pour plus d'informations sur l'utilisation de l'éditeur d'assemblages pour une API, consultez la section « L'éditeur d'assemblages ».
Recherchez la stratégie Extraire dans la palette et faites-la glisser sur votre canevas.

Spécifiez les propriétés suivantes.

Tableau 2. Extraire les propriétés de la police
Libellé de la propriété	Obligatoire	Descriptif	Type de données
Titre	Oui	Titre de la stratégie. La valeur par défaut est `extract`.	chaîne
Description	Non	Description de la stratégie.	chaîne
Racine	Oui	La source de données qui contient le contenu à transformer. La valeur par défaut est `message.body`.	chaîne
Capturer	Oui	Expression de chemin qui identifie la zone. Le paramètre par défaut est `$`, qui indique la totalité de l'entrée.	chaîne
Transformer	Oui	Expression qui définit comment transformer le contenu.	chaîne

Spécifiez une version pour la politique en cliquant sur l'icône Source et en complétant la version section correspondante du fichier YAML de la politique. Par exemple :
```
execute:
  - extract:
      version: 2.0.0
      title: extract
...
```
Vous devez spécifier une version pour la règle compatible avec la passerelle que vous utilisez. Lorsque l'API est publiée, si la version est incompatible avec la passerelle, une erreur de validation indiquant les versions disponibles est émise.
Cliquez sur Sauvegarder.

Exemple

Transformez le contenu de la zone account pour n'inclure que les 4 derniers caractères.

- extract:
    version: 2.0.0
    title: extract
    root: message.body
    extracts:
      - capture: $.members.policy.**.account
        transform: $substring($,-4)
    description: Include only the last 4 characters of the account field.