Comment écrire la logique et la syntaxe des fonctions Aviator - DataWorks

DataService Studio vous permet d'écrire des fonctions et de les associer à une API pour les utiliser comme filtres. Cette rubrique propose des exemples d'écriture de la logique fonctionnelle avec Aviator et sa syntaxe.

Scénarios

Si vous configurez une fonction en tant que pré-filtre pour une API, celle-ci peut prétraiter les paramètres de requête lors de l'appel de l'API.
Si vous configurez une fonction en tant que post-filtre pour une API, celle-ci peut retraiter et transformer les valeurs de retour lors de l'appel de l'API.

Guide d'utilisation

Pour plus d'informations sur la création, le test, la validation, la publication, la suppression, le transfert et le clonage des fonctions, consultez les rubriques Gérer les fonctions, Tester, publier et utiliser les fonctions et Publier les fonctions.
Pour savoir comment utiliser les fonctions en tant que pré-filtres et post-filtres d'API, reportez-vous à la rubrique Créer une fonction Aviator.
Pour obtenir des détails sur la syntaxe des fonctions Aviator, consultez la documentation relative à la Syntaxe des fonctions.

Exemples de paramètres d'entrée

Remarque

Dans le code Aviator, le nom de variable par défaut $0 fait référence à l'intégralité de l'entrée de la fonction.

Scénario 1 : Utiliser une fonction Aviator en tant que pré-filtre d'API
Dans ce scénario, les paramètres de requête de l'API constituent l'entrée complète de la fonction, structurée sous forme de JSON à un seul niveau. L'exemple suivant illustre les paramètres de requête en tant qu'entrée de fonction :
```
## The request parameter is user_id
## Multiple parameter values are passed when the API is called: user_id = (0,1,2)
{
  "user_id": [0,1,2]
}
```

Scénario 2 : Utiliser une fonction Aviator en tant que post-filtre d'API

Dans ce scénario, la valeur de retour de l'API constitue l'entrée complète de la fonction, structurée sous forme de JSON multiniveau. L'exemple suivant illustre une valeur de retour en tant qu'entrée de fonction :

## The return result contains three columns: user_id, city, and tags
## After the API is called, three matching data records are returned (see rows)
{
  "data": {
    "totalNum": 3,
    "pageSize": 10,
    "rows": [
      {
        "user_id": 2,
        "city": "BJ",
        "tags": "B,D,dongcs,ccccc"
      },
      {
        "user_id": 3,
        "city": "SH",
        "tags": "A,C,D,F"
      },
      {
        "user_id": 1,
        "city": "HZ",
        "tags": "A,B,C"
      }
    ],
    "pageNum": 1
  },
  "errCode": 0,
  "requestId": "0bb211c516357674333185698eb07b",
  "errMsg": "success",
  "apiLog": null
}

Exemples d'utilisation des fonctions

Scénario 1 : Utiliser une fonction Aviator en tant que pré-filtre d'API. Les exemples suivants montrent comment utiliser la fonction :

Exemple 1 : Lors de l'appel de la fonction, celle-ci modifie la valeur d'un paramètre de requête transmis par le client.

Fonction Aviator :

## For the request parameter user_id, the original value passed from the client is user_id=1
## After being processed by the filter, the actual value for the query is user_id=2
if $0.user_id == 1
{
    $0.user_id = $0.user_id + 1;
}
return $0;