Express.JS: comment puis-je définir le statut de la réponse par nom, plutôt que le nombre?

OK, tout le monde sait 200 est OK et 404 n'est pas trouvé. Mais je pour des choses comme permanent vs redirection temporaire, ou de paiement, ou d'autres plus exotiques codes d'erreur HTTP, il peut être préférable de faire quelque chose comme:

response.status('REQUEST_ENTITY_TOO_LARGE');

Plutôt que de simplement utiliser un nombre magique qui est généralement considéré comme une mauvaise pratique. Je pourrais, bien sûr, ont 413:'REQUEST_ENTITY_TOO_LARGE" dans un objet, mais l'Express a déjà une copie du code d'état -> les mappages de nom et je préfère ne pas le dupliquer.

Comment puis-je spécifier un état de la réponse donnée par nom dans l'Express JS?

Modifier: merci @Akshat pour souligner http.STATUS_CODES. L'élaboration de sa réponse, puisque les valeurs sont eux-mêmes unique, on peut exécuter:

   var statusCodeByName = {};
   for ( var number in http.STATUS_CODES ) {
     statusCodeByName[http.STATUS_CODES[number]] = number
   }

Qui permet de:

  > statusCodeByName['Request Entity Too Large']
  '413'

Pourquoi est-il mauvais pour répondre à un certain nombre? Ce nombre est bien compris par les navigateurs, si vous essayez de ne pas les envoyer ensuite comment le navigateur de faire la différence entre une erreur 404 et 500 par exemple?
De toute évidence, nous allons avoir besoin d'envoyer un certain nombre sur le fil, qui est requis par la RFC2616. Mon intérêt à être en mesure de préciser le statut de nom (évidemment encore de l'envoyer par numéro) est pour des raisons de lisibilité.

OriginalL'auteur mikemaccana | 2013-08-19

Il y a un Nœud module juste pour ce but: http status codes.

https://www.npmjs.org/package/http-status-codes

Voici ce que dit la documentation:

Installation

npm install http-status-codes

Utilisation

var HttpStatus = require('http-status-codes');

response.send(HttpStatus.OK);
response.send(
    HttpStatus.INTERNAL_SERVER_ERROR, 
    { error: HttpStatus.getStatusText(HttpStatus.INTERNAL_SERVER_ERROR) }
);

OriginalL'auteur stone

Codes de réponse HTTP ne sont pas des numéros de magie; ils sont les spec. Le texte descriptif est juste un rappel utile, mais le protocole lui-même s'appuie sur les codes d'état, et le noyau sont très vaut la peine d'apprendre. Deux pensées. Vous pouvez certainement créer une constante en haut de votre fichier et de le faire:

var REQUEST_ENTITY_TOO_LARGE = 413;
response.status(REQUEST_ENTITY_TOO_LARGE);

Cependant, la plupart des Api REST mettre en œuvre les réponses suivantes:

200 - OK
201 - Created  # Response to successful POST or PUT
302 - Found # Temporary redirect such as to /login
303 - See Other # Redirect back to page after successful login
304 - Not Modified
400 - Bad Request
401 - Unauthorized  # Not logged in
403 - Forbidden  # Accessing another user's resource
404 - Not Found
500 - Internal Server Error

Enfin, dans le cas où c'est utile, je vais partager notre code pour le rendu des pages d'erreur personnalisées:

module.exports = function(app) {
app.use(function(req, res) {
//curl https://localhost:4000/notfound -vk
//curl https://localhost:4000/notfound -vkH "Accept: application/json"
res.status(404);
if (req.accepts('html')) {
res.render('error/404', { title:'404: Page not found', error: '404: Page not found', url: req.url });
return;
}
if (req.accepts('json')) {
res.send({ title: '404: Page not found', error: '404: Page not found', url: req.url });
}
});
app.use( function(err, req, res, next) {
//curl https://localhost:4000/error/403 -vk
//curl https://localhost:4000/error/403 -vkH "Accept: application/json"
var statusCode = err.status || 500;
var statusText = '';
var errorDetail = (process.env.NODE_ENV === 'production') ? 'Sorry about this error' : err.stack;
switch (statusCode) {
case 400:
statusText = 'Bad Request';
break;
case 401:
statusText = 'Unauthorized';
break;
case 403:
statusText = 'Forbidden';
break;
case 500:
statusText = 'Internal Server Error';
break;
}
res.status(statusCode);
if (process.env.NODE_ENV !== 'production' && process.env.NODE_ENV !== 'test') {
console.log(errorDetail);
}
if (req.accepts('html')) {
res.render('error/500', { title: statusCode + ': ' + statusText, error: errorDetail, url: req.url });
return;
}
if (req.accepts('json')) {
res.send({ title: statusCode + ': ' + statusText, error: errorDetail, url: req.url });
}
});
};

Un nombre magique est un nombre qui apparaît dans le code sans nom (généralement à l'exclusion de 0 et de 1) - voir en.wikipedia.org/wiki/.... Le "texte descriptif" est en fait partie de la spec - voir la RFC2616 w3.org/Protocols/rfc2616/rfc2616-sec10.html. En outre, plutôt que de se concentrer sur ce qui les codes d'état sont très populaires, il est préférable de se concentrer sur ce qui codes d'état sont correct.

OriginalL'auteur dankohn

1

Ce n'est pas possible, sauf si vous êtes prêt à changer le code source vous-même. Jetez un oeil à la la mise en œuvre de res.send

Si vous fournissez une chaîne de caractères comme argument juste l'interprète comme html et envoie la réponse que 200.

Je pense que la raison express utilise des numéros de codes d'état HTTP est parce que le nœud lui-même utilise des numéros de clés de l'objet pour http.STATUS_CODES

Merci. http.STATUS_CODES est ce que je cherchais - puisque les valeurs ne sont pas dupliquées, vous pourrait éventuellement créer un clone inversé, touche<->les valeurs et l'utiliser.

OriginalL'auteur Akshat Jiwan Sharma

Vous devez vous connecter pour publier un commentaire.