Utiliser les JSON Schema

Il existe depuis quelques temps une spécification afin de permettre de définir une structure JSON à travers des schémas.

Cette spécification, vous pouvez la retrouver sur le lien suivant: http://json-schema.org/specification.html

Le principe: définir à travers un JSON des règles afin de pouvoir valider d'autres JSON. Cela permet d'avoir comme sur le site http://schema.org/docs/gs.html des schémas de données qui permettent de mieux comprendre les données que nous recevons.

Ainsi, nous pouvons définir le schéma suivant:

'use strict';

module.exports = {
    "title": "Person",
    "type": "object",
    "properties": {
        "firstName": {
            "type": "string"        },
        "lastName": {
            "type": "string"        },
        "age": {
            "description": "Age in years",
            "type": "integer",
            "minimum": 0        }
    },
    "required": ["firstName", "lastName"]
};

Ce dernier indique:
  • Que firstName est une string et est obligatoire
  • Que lastName est une string et est obligatoire
  • Que age est un nombre entier positif et n'est pas obligatoire.

Voyons le bout de code suivant:


'use strict';

const Ajv  = require('ajv');
const ajv  = new Ajv();
const userSchema = require('./user-schema');

let data = {
    firstName: 'John',
    lastName: 'Doe',
    age: 15};

if (!ajv.validate(userSchema, data)) {
    console.error(JSON.stringify(ajv.errors, null, 3));

} else {
    console.info('Data has got a valid schema')
}

Si nous l'exécutons, nous n'aurons pas d'ailleurs car nous remplissons tous les critères.
Essayons maintenant avec un âge à 15.5
Nous obtenons alors l'erreur:


[
   {
      "keyword": "type",
      "dataPath": ".age",
      "schemaPath": "#/properties/age/type",
      "params": {
         "type": "integer"
      },
      "message": "should be integer"
   }
]


Si nous mettons un âge négatif:


[
   {
      "keyword": "minimum",
      "dataPath": ".age",
      "schemaPath": "#/properties/age/minimum",
      "params": {
         "comparison": ">=",
         "limit": 0,
         "exclusive": false
      },
      "message": "should be >= 0"
   }
]

Et si nous oublions un champ obligatoire:


[
   {
      "keyword": "required",
      "dataPath": "",
      "schemaPath": "#/required",
      "params": {
         "missingProperty": "lastName"
      },
      "message": "should have required property 'lastName'"
   }
]

Bref, c'est un outils qui est très intéressant car nous pouvons ainsi permettre de valider à n'importe quel moment nos données un peu critiques qui transitent dans nos applications Web ou NodeJs.

Commentaires

Enregistrer un commentaire

Posts les plus consultés de ce blog

ISO: liens & outils utiles

Image
Voici quelques normes ISO à connaître et que vous aurez à faire face dans vos développements. Et quelques liens / outils permettant de s'assurer que nous faisons correctement leurs intégrations Code Pays https://countrycode.org/ est super site qui permet de lister les pays du monde avec leur country code (en mode number et iso): Et par pays, nous pouvons avoir des informations supplémentaires, comme le format téléphone, la position géographique, la time zone, la monnaie, etc: Ce site du coup regroupe les country code: En ISO 3166 name (où un nom est attribué à un pays) En ISO 3166 numeric (où un chiffre numérique est attribué à un pays) En ISO 3166-1 alpha-2 (code en 2 alpha majuscule) En ISO 3166-1 alpha-3 (code en 3 alpha majuscule) Ainsi que les langues. Tout cela est d'ailleurs regroupés dans ce fichier téléchargeable . Code langue / locale Là, nous tombons dans un des plus grands soucis d'un développeur: co...
Lire la suite

NodeJs et SSL: une petite analyse

Le but de cet article est de faire un petit tour d'horizon de l'usage de SSL dans nos applications NodeJs, en l'occurence, quand nous souhaitons faire une application Web, une API REST, ou les deux. Nous allons avoir 6 étapes pour de réalisation d'un serveur NodeJs, avec à chaque fois 12 clients: Un client NodeJs sans certificats SSL - strictSSL à false Un client NodeJs sans certificats SSL - strictSSL à true Un client NodeJs avec un certificat SSL client non fiable - strictSSL à false Un client NodeJs avec un certificat SSL client non fiable - strictSSL à true Un client NodeJs avec un certificat SSL server non fiable - strictSSL à false Un client NodeJs avec un certificat SSL server non fiable - strictSSL à true Un client NodeJs avec un certificat SSL client fiable - strictSSL à false Un client NodeJs avec un certificat SSL client fiable - strictSSL à true Un client NodeJs avec un certificat SSL serveur fiable - strictSSL à false...
Lire la suite

Créer sa commande slack en quelques minutes

Image
Le but de cet article est de vous montrer que très simplement, nous pouvons créer une commande personnalisée pour Slack. Ici, nous allons afficher des chats :)" Tout d'abord, nous allons nous créer des comptes sur: Slack:  https://slack.com Heroku:  http://www.heroku.com/ qui permettra d'héberger notre service REST pour Slack Gitlab: https://gitlab.com  qui permet évidemment d'héberger notre code, mais qui pourra de manière automatiser déployer notre application sur Heroku à chaque commit (et cela, même en mode "gratuit") Concentrons-nous tout d'abord sur Heroku et Gitlab. Créons un compte Heroku. Une fois cela fait, aller dans votre compte :. Vous verrez alors une section nommée "API key": Cliquez sur "Reveal" pour voir la valeur et conservez la bien en mémoire. Ensuite, sur en retournant sur votre dashboard d'applications Heroku , cliquez sur "New" et créez une nouvelle application. Dans...
Lire la suite