\n\nUne grande partie du développement moderne nécessite la création d'API, qu'il s'agisse simplement de fournir des données à un programme lourd en JavaScript, single page ou en tant que produit autonome. \n\nExpress Rest Response fournit un trait de réponse API qui peut être utilisé avec n'importe quel contrôleur pour simplifier les types de réponse courants, sans avoir besoin de se rappeler quel code d'état HTTP doit être renvoyé pour quels types de réponse.\n\n\n#### Installation\n*************\nvia [npm](https://npmjs.org/)\n\n```sh\n$ npm install express-rest-response --save\n```\n\nvia [yarn](https://yarnpkg.com)\n\n```sh\n$ yarn add express-rest-response\n```\n\n#### Utilisation\n*************\n```javascript\nconst express = require('express')\nconst app = express()\n\napp.use(express.urlencoded({extended: true}))\napp.use(express.json())\n\n// Utilisation du middleware express-rest-response\nconst responder = require('express-rest-response')\napp.use(responder())\n\nconst routes = require('./router')\napp.use('/api', routes)\n\nconst PORT = process.env.PORT || 4000\napp.listen(PORT, function(req,res){\n console.log(`sever is listening on port ${PORT}`)}\n)\n```\n\n\n#### Exemple d'utilisation\n*************\nL'exemple suivant montre un modèle d'utilisation courant au sein de vos contrôleurs.\n\n```js\nconst bcrypt = require('bcrypt')\nconst User = require('../models/User')\n\nexports.register = function (req, res) {\n const {email, name, password} = req.body\n\n \t//create newUser\n User.create({\n \tpassword : bcrypt.hashSync(password, 10),\n name,\n email \n\t}).then(user => {\n res.respondCreated()\n\t})\n}\n```\n\nDans cet exemple, un code d'état HTTP de 201 est renvoyé, avec le message d'état générique \"Créé\". Des méthodes existent pour les cas d'utilisation les plus courants :\n\n```javascript\n// Réponse générique\nres.respond(data, status = 200);\n\n// Réponse générique d'echec\nres.respondFail(message = \"An error has occurred\", status = 500, code = null, errors = []);\n\n// Réponse générique de succès\nres.respondSuccess(message = \"Result\", result = null, status = 200);\n\n\n// Création de resource\nres.respondCreated(message = \"Created\", result = null);\n\n// Suppression de resource\nres.respondDeleted(message = \"Deleted\", result = null);\n\n// Commande exécutée sans réponse requise\nres.respondNoContent(message = \"No Content\");\n\n// Tout est ok\nres.respondOk(message = \"Ok\", result = null);\n\n// Mise à jour de resource\nres.respondUpdated(message = \"Updated\", result = null);\n\n\n// Les données envoyées sont invalides\nres.respondBadRequest(message = \"Bad Request\", code = 400, errors = []);\n\n// Ressource déja existante\nres.respondConflict(message = \"Conflict\", code = 409, errors = []);\n\n// Action interdite\nres.respondForbidden(message = \"Forbidden\", code = 403, errors = []);\n\n// Ressource précédement supprimée\nres.respondGone(message = \"Gone\", code = 410, errors = []);\n\n// Erreur interne\nres.respondInternalError(message = \"Internal Server Error\", code = 500, errors = []);\n\n// Token d'authentification expriré ou invalide\nres.respondInvalidToken(message = \"Invalid Token\", code = 498);\n\n// Méthode d'accès non autorisée\nres.respondMethodNotAllowed(message = \"Method Not Allowed\", code = 405, errors = []);\n\n// \tRessource non disponible dans un format qui respecterait les en-têtes « Accept » de la requête\nres.respondNotAcceptable(message = \"Not Acceptable\", code = 406, errors = []);\n\n// Ressource introuvable\nres.respondNotFound(message = \"Not Found\", code = 404, errors = []);\n\n// Ressource non disponible dans un format qui respecterait les en-têtes « Accept » de la requête\nres.respondNotAcceptable(message = \"Not Acceptable\", code = 406, errors = []);\n\n// Fonctionnalité réclamée non supportée par le serveur.\nres.respondNotImplemented(message = \"Not Implemented\", code = 501);\n\n// Le client a fait trop de demandes\nres.respondTooManyRequests(message = \"Too Many Requests\", code = 429, errors = []);\n\n// Le client n'est pas autorisé\nres.respondUnauthorized(message = \"Unauthorized\", code = 401, errors = []);\n```\n\n#### Référence de classe\n**************\n#### `respond(data: mixed, status?: number = 200)`\n\nC'est la méthode utilisée par toutes les autres méthodes de ce trait pour renvoyer une réponse au client.\n\n`paramètres`:\n\n * `data` — Les données à renvoyer au client. Chaîne ou tableau ou objet littéral\n * `status` — Code d'état HTTP à renvoyer. Par défaut à 200\n\n#### `respondFail(message?: string = \"An error has occurred\", status?: number = 500, code?: int|string|null = null, errors?: array = [])`\n\nC'est la méthode générique utilisée pour représenter une réponse ayant échoué et est utilisée par toutes les autres méthodes d'échec.\n\n`Paramètres`:\n\n * `message` — Le message décrivant l'erreur\n * `status` — Code d'état HTTP à renvoyer. Par défaut à 500\n * `code` — Un code d'erreur personnalisé, spécifique à l'API\n * `errors` — La liste des erreurs rencontrées\n\t \nÉtant donné que de nombreuses API sont mieux servies à l'aide de codes d'erreur personnalisés, un code d'erreur personnalisé peut être transmis dans le troisième paramètre. Si aucune valeur n'est présente, ce sera la même chose que `status`.\n\n`Réponse`:\nLa réponse est un tableau avec 4 éléments : `message`, `success`, `code` et `errors`. \n* L'élément `success` est un booléen ayant la valeur `FALSE` spécifiant le fait qu'il y'a un échec de l'opération\n* L'élément `errors` est un tableau contenant la liste des erreurs, ci celles-ci on été spécifiées\n\nCela ressemblerait à quelque chose comme :\n```json\n{\n \"message\": \"Insuffisiant balance\",\n \"success\": false,\n \"code\": 909\n}\n```\n#### `respondSuccess(message?: string = \"Result\", result: mixed = null, status?: number = 200)`\n\nC'est la méthode générique utilisée pour représenter une réponse ayant réussie et est utilisée par toutes les autres méthodes de réussite.\n\n`Paramètres`:\n\n * `message` — Le message décrivant la réussite\n * `result` — Les résultat à envoyer au client\n * `status` — Code d'état HTTP à renvoyer. Par défaut à 200\n\t \n`Réponse`:\nLa réponse est un tableau avec 3 éléments : `message`, `success`, et `result`. \n* L'élément `success` est un booléen ayant la valeur `TRUE` spécifiant le fait que l'opération s'est bien passée\n* L'élément `result` contient les données renvoyés\n\nCela ressemblerait à quelque chose comme :\n```json\n{\n \"message\": \"Connection successfully\",\n \"success\": true,\n \"result\": {\n \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyaWQiOiI2MmZmNGRlM2VkYzY0NTUyNDIzZjBjZDkiLCJpYXQiOjE2NjA5MDM0MDQsImV4cCI6MTY2MDk4OTgwNH0.rgCt_E7xEMjsFSAKGl9pngrGF4-13_ExLIu0kXikd3k\",\n \"id\": \"62ff4de3edc64552423f0cd9\"\n }\n}\n```\n\nLes 3 méthodes ci-dessus sont les méthodes principales. Il existe néanmoins des méthodes plus spécifique en fonction de vos besoins\n\n#### `respondCreated(message?: string = \"Created\", result: mixed = null)`\n\n Définit le code d'état approprié à utiliser lors de la création d'une nouvelle ressource, généralement 201.\n\n`Paramètres`:\n\n * `message` — Le message décrivant la création\n * `result` — Les résultat à envoyer au client\n\t \n`Réponse`:\nLa réponse est un tableau avec 3 éléments : `message`, `success`, et `result`. \n* L'élément `success` est un booléen ayant la valeur `TRUE` spécifiant le fait que l'opération s'est bien passée\n* L'élément `result` contient les données renvoyés\nL'exemple ci dessous\n\n```javascript\nUser.create({\n password : bcrypt.hashSync(password, 10),\n name,\n email \n}).then(user => {\n res.respondCreated('User created successfully', user)\n})\n```\n\nRenverra une réponse comme :\n```json\n\"message\": \"User created successfully\",\n\"success\": true,\n\"result\": {\n \"password\": \"$2b$10$it8MOxq3UMlyqA4SODsD2uFafTreOQJPIdyGYQfGl2CJiKX4N81mq\",\n \"phone\": \"xxxxxxxxx\",\n \"name\": \"John Doe\",\n \"email\": \"johndoe@email.com\",\n \"_id\": \"62ff7f7adf90b9d003a47b53\",\n \"__v\": 0\n}\n```\n\n#### `respondDeleted(message?: string = \"Deleted\", result: mixed = null)`\n\nDéfinit le code d'état approprié à utiliser lorsqu'une nouvelle ressource a été supprimée à la suite de et appel d'API, généralement 200.\n\n#### `respondNoContent(message?: string = \"No Content\")`\n\nDéfinit le code d'état approprié à utiliser lorsqu'une commande a été exécutée avec succès par le serveur mais qu'il n'y a pas réponse significative à renvoyer au client, généralement 204.\n\n#### `respondBadRequest(message?: string = \"Bad Request\", code?: number|string|null = null, errors?: array)`\n\nDéfinit le code d'état approprié à utiliser lorsque les données envoyées par le client ne satisfont pas aux règles de validation. Le code d'état est généralement 400.\n```javascript\nreturn res.respondBadRequest('Invalid phone number');\n```\n#### `respondConflict(message?: string = \"Conflict\", code?: number|string|null = null, errors?: array)`\nDéfinit le code d'état approprié à utiliser lorsque la ressource que le client essaie de créer existe déjà. Le code d'état est généralement 409.\n```javascript\nreturn res.respondConflict('A user already exists with that email.');\n```\n#### `respondForbidden(message?: string = \"Forbidden\", code?: number|string|null = null, errors?: array)`\n\nContrairement à `respondUnauthorized()`, cette méthode doit être utilisée lorsque le point de terminaison d'API demandé n'est jamais autorisé. `Non autorisé` implique que le client est encouragé à réessayer avec des informations d'identification différentes. Avec `interdits`, le client ne doit pas réessayer car cela n'aidera pas. Le code d'état est 403.\n```javascript\nreturn res.respondForbidden('Invalid API endpoint.');\n```\n#### `respondGone(message?: string = \"Gone\", code?: number|string|null = null, errors?: array)`\nDéfinit le code d'état approprié à utiliser lorsque la ressource demandée a été précédemment supprimée et n'est plus disponible. Le code d'état est généralement 410.\n```javascript\nreturn res.respondGone('That user has been previously deleted.');\n```\n#### `respondInternalError(message?: string = \"Internal Server Error\", code?: number|string|null = null, errors?: array)`\nDéfinit le code d'état approprié à utiliser en cas d'erreur de serveur. Le code d'état est généralement 500.\n```javascript\ntry {\n ...\n}\ncatch(err) {\n return res.respondInternalError(err.message);\n}\n```\n#### `respondInvalidToken(message?: string = \"Invalid Token\", code?: number|string|null = null)`\nDéfinit le code d'état approprié à utiliser lorsque le token utilisé pour l'authentification de l'utilisateur a expiré ou est invalide. Le code d'état est généralement 498.\n```javascript\nreturn res.respondInvalidToken();\n```\n#### `respondNotFound(message?: string = \"Not Found\", code?: number|string|null = null, errors?: array)`\nDéfinit le code d'état approprié à utiliser lorsque la ressource demandée est introuvable. Le code d'état est 404.\n```javascript\nreturn res.respondNotFound('User 13 cannot be found.');\n```\n#### `respondTooManyRequests(message?: string = \"Too many requests\", code?: number|string|null = null, errors?: array)`\nDéfinit le code d'état approprié à utiliser lorsque le client a appelé trop de fois un point de terminaison d'API. Cela peut être dû à une certaine forme de limitation ou de limitation de débit. Le code d'état est généralement 400.\n```javascript\nreturn res.respondTooManyRequests('You must wait 15 seconds before making another request.');\n```\n#### `respondUnauthorized(message?: string = \"Unauthorized\", code?: number|string|null = null, errors?: array)`\n\nDéfinit le code d'état approprié à utiliser lorsque l'utilisateur n'a pas été autorisé, ou a une autorisation incorrecte. Le code d'état est 401.\n```javascript\nreturn res.respondUnauthorized('Invalid Auth token');\n```","readmeFilename":"README.md"}
![](\"https://img.shields.io/npm/v/express-rest-response.svg\")
\n ![](\"https://img.shields.io/npm/dt/express-rest-response.svg\")
\n
\n ![](\"https://img.shields.io/badge/license-MIT-blue.svg\"){kind=icon}
\n \n ![](\"http://img.badgesize.io/dimtrovich/express-rest-response/main/dist/bundle.min.js.svg?compression=gzip&style=flat-square\")
\n \n