DBAPI : Comment effectuer la validation des paramètres de requête API

Exercice pratique

Cas 1 – Vérifier que la longueur d’une chaîne de caractères ne dépasse pas 4

• Dans le projet « Validation des paramètres », cliquez sur « Ajouter une règle de validation ».

• Dans le script de validation, saisissez le code JavaScript correspondant, par exemple name.length < 5. Indiquez ensuite le message d’erreur à afficher en cas d’échec ; lorsque cette règle de validation échoue, ce message s’affichera.

Remarque : Le code JavaScript peut s’étendre sur plusieurs lignes, à condition que la dernière ligne soit une expression booléenne ou une variable booléenne, chaque instruction étant terminée par un point-virgule. Par exemple : var res = name.length < 5; res;

• Vous pouvez directement référencer les noms des paramètres définis dans la requête dans votre code.

• Enregistrez l’API et mettez-la en ligne.
• Rendez-vous sur la page de test de la requête API, saisissez une chaîne relativement longue et lancez la requête ; vous verrez alors apparaître le message d’erreur correspondant.

Cas 2 – Validation de plusieurs paramètres

• Si l’API comporte plusieurs paramètres, chacun d’eux peut faire l’objet d’une validation.

Vous pouvez cliquer sur le bouton « Ajouter » pour créer autant de règles de validation que nécessaire.

Cas 3 – Validation entre plusieurs paramètres

Cas 4 – Validation de paramètres JSON imbriqués complexes

• Pour les API utilisant le format application/json, il est également possible d’effectuer des validations sur les paramètres.

Remarque

• Cette fonctionnalité n’est disponible qu’en version entreprise ; elle a été introduite dans la version entreprise 4.1.0 de DBAPI.