2016-11-20 3 views
0

Je construis une API et je repars ce genre de codes d'état pour chaque méthode (par exemple, « register_user »):Les meilleures pratiques pour les codes d'état de réponse API

  • 200 (OK) lorsque l'utilisateur a été enregistré avec succès
  • 403 (interdit) quand il y a des paramètres manquants dans la demande
  • 409 (conflit) lorsqu'un utilisateur a déjà été enregistré

En plus du code d'état, je renvoie un champ "message" expliquant ce qui s'est passé. Considérez-vous que renvoyer ces codes dans cet exemple est une bonne pratique? Ou devrais-je retourner 200 dans tous, mais une erreur dans le champ "message"?

+2

Comme la situation n'est pas correcte, vous ne devriez pas retourner 200 –

+2

Jetez un oeil à cette ressource http://www.restapitutorial.com/httpstatuscodes.html. Vous devriez regarder 400 - Bad Request pour les paramètres manquants. – Nkosi

Répondre

0

Le code d'état 403 (Interdit) indique que le serveur a compris la requête mais refuse de l'autoriser. Un serveur qui souhaite rendre public pourquoi la requête a été interdite peut décrire cette raison dans la charge utile de réponse (le cas échéant).

- RFC 7231, 6.5.3

Cela ne ressemble pas à ce que vous avez du tout. Les deux autres sont raisonnables. Les paramètres manquants sont généralement gérés avec un code de réponse 400.