NodeJS robuste API est un boilerplate pour la conception des API RESTfull. Cette API repose sur une architecture totalement maintenable et réutilisable.

• Créer un projet
• Lister tous les produits avec une option de pagination
• Obtenir un produit spécifique à partir de son ID
• Modifier un produit
• Supprimer un produit
• Créer un admin
• Connecter un admin en utilisant JWT
• Documentation de l'API avec Swagger.

Server:

Database:

Schema & validation des requêtes:

Documentation:

Vous devez disposer de NodeJS && npm installé sur votre machine

1. Cloner ou télécharger le projet. Si vous décidez de cloner le projet exécutez les commandes en dessous, dans un dossier créer préalablement.

git clone https://github.com/angestephane/robust-nodeJS-api.git .

2. Installer les dépendances

npm install

3. Exécution

npm run dev

Dans un fichier .env que vous allez créer :

1. Ajoutez les variables d'environnement pour la connexion à la base de données : DB_URL

2. Définissez un port d'accès au server, sinon le port par défaut sera 3000 : PORT

3. Explorer le code et modifier les schemas et modèles en fonction de vos besoins. L'API s'adaptera.

L'API présenté dans ce projet à été document avec Swagger.
Cette documentation est accessible uniquement en mode dev
Pour consulter la documentation :

1. exécuter le projet :

npm run dev

2. Vous vous rendez ensuite sur : http://localhost:3002/api-docs/

Je serai ravi d'avoir vos remarques et avis sur un point particulier de l'API.

MIT