Menu

Codes de réponse de l'API Rest et types de demandes de repos

  • Principal
  • Autre
  • Codes de réponse de l'API Rest et types de demandes de repos

rest api response codes

Essayez Notre Instrument Pour Éliminer Les Problèmes

Dans ce didacticiel, nous découvrirons les différents codes de réponse REST, les types de requêtes REST et certaines bonnes pratiques à suivre. :

Dans le didacticiel précédent, REST API Architecture and Constraints, nous avons découvert les services Web, l'architecture REST, POSTMAN, etc.

Nous pouvons nous référer au premier tutoriel de l'API REST pour plus d'informations à ce sujet.

Chaque fois que vous recherchez un mot ou une phrase dans un moteur de recherche, le moteur de recherche envoie la demande au serveur Web. Le serveur Web renvoie un code de réponse à trois chiffres qui indique l'état de la demande.

Différents types de codes de réponse et de demandes de repos

Ce que vous apprendrez:

Codes de réponse de l'API Rest

Voici quelques exemples de codes de réponse que nous verrons normalement lors de l'exécution de tests d'API REST sur POSTMAN ou sur n'importe quel client d'API REST.

# 1) Série 100
Ce sont des réponses temporaires

  • 100 Continuer
  • 101 Protocoles de commutation
  • 102 Traitement

# 2) Série 200
Le client accepte la demande et est traitée avec succès sur le serveur.

comment ouvrir les fichiers jar sous windows
  • 200 - OK
  • 201 - Créé
  • 202 - Accepté
  • 203 - Informations ne faisant pas autorité
  • 204 - Pas de contenu
  • 205 - Réinitialiser le contenu
  • 206 - Contenu partiel
  • 207 - Multi-états
  • 208 - Déjà signalé
  • 226 - IM utilisé

# 3) Série 300
La plupart des codes liés à cette série concernent la redirection d'URL.

  • 300 - Choix multiples
  • 301 Déménagé Définitivement
  • 302 - Trouvé
  • 303 - Vérifier autre
  • 304 - Non modifié
  • 305 - Utiliser un proxy
  • 306 - Proxy de commutation
  • 307 - Redirection temporaire
  • 308 - Redirection permanente

# 4) Série 400
Ceux-ci sont spécifiques à l'erreur côté client.

  • 400 - Mauvaise demande
  • 401 - Non autorisé
  • 402 - Paiement requis
  • 403 - Interdit
  • 404 - Non trouvé
  • 405 - Méthode non autorisée
  • 406 - Non acceptable
  • 407 - Authentification proxy requise
  • 408 - Délai d'expiration de la demande
  • 409 - Conflit
  • 410 - Parti
  • 411 - Longueur requise
  • 412 - Échec de la condition préalable
  • 413 - Charge utile trop importante
  • 414 - URI trop long
  • 415 - Type de support non pris en charge
  • 416 - Gamme non satisfaisante
  • 417 - L'attente a échoué
  • 418 - Je suis une théière
  • 421 - Demande mal dirigée
  • 422 - Entité non traitable
  • 423 - Verrouillé
  • 424 - Dépendance échouée
  • 426 - Mise à niveau requise
  • 428 - Condition préalable requise
  • 429 - Trop de demandes
  • 431 - Champs d'en-tête de demande trop grands
  • 451 - Indisponible pour des raisons juridiques

# 5) Série 500
Ceux-ci sont spécifiques à l'erreur côté serveur.

  • 500 - Erreur de serveur interne
  • 501 - Non mis en œuvre
  • 502 Mauvaise passerelle
  • 503 Service Indisponible
  • 504 portail expiré
  • 505 - Version HTTP non prise en charge
  • 506 - La variante négocie également
  • 507 - Stockage insuffisant
  • 508 - Boucle détectée
  • 510 - Non étendu
  • 511 - Authentification réseau requise

En dehors de cela, il existe plusieurs codes différents mais ceux-ci nous détourneront de notre discussion actuelle.

Différents types de requêtes REST

Ici, nous allons discuter de chaque méthode de l'API REST avec les collections.

MéthodeDescription
PIÈCETrès similaire à mettre mais cela ressemble plus à une manipulation mineure du contenu des ressources
OBTENIRRécupérer la ligne d'état, le corps de la réponse, l'en-tête, etc.
DIRIGERIdentique à GET, mais ne récupère que la ligne d'état et la section d'en-tête
PUBLIEREffectuer la demande en utilisant la charge utile de la demande principalement lors de la création d'un enregistrement sur le serveur
METTREUtile pour manipuler / mettre à jour la ressource à l'aide de la charge utile de la requête
EFFACERSupprime les informations relatives à la ressource cible.
OPTIONSDécrire les options de communication pour la ressource cible

Remarque: Il existe tellement de méthodes que nous pouvons faire avec POSTMAN, mais nous ne discuterons que des méthodes suivantes en utilisant POSTMAN.

Nous utiliserons une URL factice pour démontrer http://jsonplaceholder.typicode.com . Cette URL doit nous donner les réponses souhaitées mais il n'y aura aucune création, modification dans le serveur.

# 1) OBTENIR

Paramètres de la demande:
Méthode: GET
Demande d'URI: http://jsonplaceholder.typicode.com/posts
Paramètre de requête: id = 3;

Réponse reçue:
Code d'état de réponse: 200 OK

Corps de réponse :

Corps de réponse

# 2) TÊTE

Paramètres de la demande:
Méthode: HEAD
Demande d'URI: http://jsonplaceholder.typicode.com/posts

DIRIGER

# 3) POST

PUBLIER

# 4) METTRE

METTRE

EFFACER

# 5) OPTIONS

Paramètres de la demande:
Méthode: OPTIONS
Demande d'URI: http://jsonplaceholder.typicode.com/
En-têtes: Content-type = Application / JSON

OPTIONS

quelle est la phase d'implémentation dans le sdlc

# 6) PATCH

PIÈCE

Meilleures pratiques lors de la validation d'une API REST

# 1) Opérations CRUD

Comprend au minimum 4 méthodes fournies et doit fonctionner dans l'API Web.
GET, POST, PUT et DELETE.

# 2) Gestion des erreurs

Indices possibles pour les consommateurs d'API sur l'erreur et pourquoi elle s'est produite. Il doit également fournir des messages d'erreur de niveau granulaire.

# 3) Gestion des versions d'API

Utilisez la lettre «v» dans l'URL pour indiquer la version de l'API. Par exemple-

http://restapi.com/api/v3/passed/319

Paramètre supplémentaire à la fin de l'URL

http://restapi.com/api/user/invaiiduser?v=6.0

# 4) Filtrage

En permettant à l'utilisateur de spécifier, sélectionnez les données souhaitées au lieu de les fournir toutes à la fois.
/ contact / sam? nom, âge, désignation, bureau
/ contacts? limit = 25 & offset = 20

# 5) Sécurité

Horodatage dans chaque demande et réponse API. Utilisation de access_token pour s'assurer que l'API est appelée par les parties de confiance.

meilleur logiciel pour surveiller la température du processeur et du GPU

# 6) Analyse

Avoir Analytics dans votre API REST vous donnera un bon aperçu de l'API testée, en particulier lorsque le nombre d'enregistrements récupérés est très élevé.

# 7) Documentation

Une documentation appropriée doit être fournie afin que les consommateurs d'API puissent l'utiliser et consommer les services efficacement.

# 8) Structure d'URL

La structure de l'URL doit rester simple et un utilisateur doit pouvoir lire facilement le nom de domaine dessus.

Par exemple , https://api.testdomain.com.

Les opérations à effectuer sur l'API Rest doivent également être très faciles à comprendre et à exécuter.

Par exemple, pour un client de messagerie:

OBTENIR: read / inbox / messages - Récupère la liste de tous les messages sous la boîte de réception
OBTENIR: read / inbox / messages / 10 - Lit 10emessage dans la boîte de réception
PUBLIER: create / inbox / folders - Créer un nouveau dossier sous la boîte de réception
EFFACER: Supprimer / spam / messages - Supprimer tous les messages du dossier spam
METTRE: dossiers / boîte de réception / sous-dossier - Mettez à jour les informations relatives au sous-dossier sous boîte de réception.

Conclusion

De nombreuses organisations préfèrent implémenter l'API Web REST car elle est très facile à implémenter, a des normes et des règles moins strictes à suivre, facile d'accès, légère et facile à comprendre. POSTMAN a ses avantages lorsqu'il est utilisé avec l'API RESTful en raison de son interface utilisateur conviviale, de sa facilité d'utilisation et de test, de son taux de réponse plus rapide et de sa nouvelle fonctionnalité RUNNER.

Dans le prochain tutoriel de cette série de tutoriels sur l'API Rest, nous automatiserons les cas de test que nous avons exécutés manuellement.

lecture recommandée

^