Le temps de documenter l’api est arrivé, pour cela deux outils opensource sont souvent utilisés, Swagger et apidocjs. J’ai choisi apidoc, pour sa simplicité d’installation, et la rapidité de sa prise en main, de plus sur npmtrends (donc un monde plutôt javascript) apidoc à 8280 stars et swagger 3677, toutefois swagger je le sais, est un très bon outil….. On commence donc par installer apidoc en global sur son ordinateur (il est possible qu’il faille taper sudo avant la commande…) NB : doc officielle super bien faite https://apidocjs.

J’ai créé l’ Api avec une authentification jsonwebtoken, avant d’aller plus loin, c’est à dire : ajouter des endpoints à mon Api, créer une doc Api, refactoriser, et plus globalement faire grossir mon application, je vais implémenter les tests, pour ça j’ai choisi Jest et Supertest… NB: Pour simplifier l’exercice, je me suis créé une base données locale, toujours en PostgreSQL, mais on peut faire ceci avec n’importe quelle base de données (il faudra juste adapter les requêtes au type de bdd) On peut même sauvegarder en local (dans ce cas mettre les méthodes dans un setTimeout pour simuler une requête asynchrone)

La base de données est installée, je vais donc y stocker le password de manière sécuriser, je vais également implémenter la sécurisation de mes routes par un json web token. Dans src, je crée un dossier globalHelper et un dossier middlewares. J’installe ensuite les 2 dépendances dont j’aurais besoin pour sécuriser le password et générer un token npm install jsonwebtoken bcryptjs --save Par la suite dans mon fichier config/env je vais affecter une valeur à ma propriété env.

Maintenant que koa, Typescript, nodemon sont installés, on va automatiser les tâches de build et de dev. Pour cela j’ai choisi de me servir de concurrently npm install --save-dev concurrently Je rajoute quelques petits scripts au package.json, pour les scripts de tests on verra plus tard. Maintenant la commande npm run dev permet de développer en voyant les changement immédiatement (les erreurs de compilation aussi) "scripts": { "test": "echo \"Error: no test specified\" && exit 1", "dev": "concurrently -k \"tsc -p .

Koa est un framework écrit par l’équipe de développement d’Express, en voici une présentation complète avec l’ajout de Typescript. Pourquoi Koa ? Koa a été écrit après Express il est super light (encore plus light qu’Express) et il se base sur le principe d’ async / await ce qui le rend très très lisible Pré-requis : Node, Nodemon, Typescript installé en global sur l’ordinateur. Un IDE moderne Visual studio code(gratuit) ou Webstorm(payant) mkdir starter_koa cd starter_koa npm init -y git init # si git est installé sur l'ordinateur npm i koa koa-router koa-body koa-json koa-logger touch .