Menü

Rest-API-Antwortcodes und Arten von Rest-Anforderungen

  • Haupt
  • Andere
  • Rest-API-Antwortcodes und Arten von Rest-Anforderungen

rest api response codes

Versuchen Sie Unser Instrument, Um Probleme Zu Beseitigen

In diesem Lernprogramm erfahren Sie mehr über verschiedene REST-Antwortcodes, Arten von REST-Anforderungen und einige bewährte Methoden, die befolgt werden müssen ::

Im vorherigen Lernprogramm, REST-API-Architektur und Einschränkungen, haben wir Informationen zu Webdiensten, REST-Architektur, POSTMAN usw. erhalten.

Weitere Informationen hierzu finden Sie im ersten Tutorial zur REST-API.

Immer wenn Sie ein Wort oder eine Phrase in einer Suchmaschine suchen, sendet die Suchmaschine die Anfrage an den Webserver. Der Webserver gibt einen dreistelligen Antwortcode zurück, der den Status der Anforderung angibt.

Verschiedene Arten von Antwortcodes und Restanfragen

Was du lernen wirst:

Rest-API-Antwortcodes

Hier sind einige Beispiel-Antwortcodes, die normalerweise beim Ausführen von REST-API-Tests über POSTMAN oder einen beliebigen REST-API-Client angezeigt werden.

# 1) 100er Serie
Dies sind vorübergehende Antworten

  • 100 Weiter
  • 101 Vermittlungsprotokolle
  • 102 Verarbeitung

# 2) Serie 200
Der Client akzeptiert die Anforderung und wird auf dem Server erfolgreich verarbeitet.

einfacher binärer Baum c ++
  • 200 - OK
  • 201 - Erstellt
  • 202 - Akzeptiert
  • 203 - Nicht maßgebliche Informationen
  • 204 - Kein Inhalt
  • 205 - Inhalt zurücksetzen
  • 206 - Teilinhalt
  • 207 - Multi-Status
  • 208 - Bereits gemeldet
  • 226 - IM verwendet

# 3) 300er Serie
Die meisten Codes für diese Serie sind für die URL-Umleitung bestimmt.

  • 300 - Mehrere Auswahlmöglichkeiten
  • 301 - Dauerhaft verschoben
  • 302 - gefunden
  • 303 - Andere prüfen
  • 304 - Nicht geändert
  • 305 - Proxy verwenden
  • 306 - Switch Proxy
  • 307 - Temporäre Weiterleitung
  • 308 - Permanente Weiterleitung

# 4) Serie 400
Diese sind spezifisch für clientseitige Fehler.

  • 400 - Schlechte Anfrage
  • 401 - Nicht autorisiert
  • 402 - Zahlung erforderlich
  • 403 Verboten
  • 404 Nicht gefunden
  • 405 - Methode nicht zulässig
  • 406 - Nicht akzeptabel
  • 407 - Proxy-Authentifizierung erforderlich
  • 408 Anfrage timeout
  • 409 - Konflikt
  • 410 - Vorbei
  • 411 - Länge erforderlich
  • 412 - Voraussetzung fehlgeschlagen
  • 413 - Nutzlast zu groß
  • 414 - URI zu lang
  • 415 - Nicht unterstützter Medientyp
  • 416 - Reichweite nicht zufriedenstellend
  • 417 - Erwartung fehlgeschlagen
  • 418 - Ich bin eine Teekanne
  • 421 - Fehlgeleitete Anfrage
  • 422 - Nicht verarbeitbare Entität
  • 423 - Gesperrt
  • 424 - Fehlgeschlagene Abhängigkeit
  • 426 - Upgrade erforderlich
  • 428 - Voraussetzung erforderlich
  • 429 - Zu viele Anfragen
  • 431 - Anforderungsheaderfelder zu groß
  • 451 - Aus rechtlichen Gründen nicht verfügbar

# 5) 500er Serie
Diese sind spezifisch für den serverseitigen Fehler.

  • 500 - Interner Serverfehler
  • 501 - Nicht implementiert
  • 502 Bad Gateway
  • 503 Dienst nicht verfügbar
  • 504 - Gateway-Zeitüberschreitung
  • 505 - HTTP-Version wird nicht unterstützt
  • 506 - Variante verhandelt auch
  • 507 - Unzureichender Speicher
  • 508 - Schleife erkannt
  • 510 - Nicht erweitert
  • 511 - Netzwerkauthentifizierung erforderlich

Abgesehen davon gibt es verschiedene Codes, die uns jedoch von unserer aktuellen Diskussion abweichen.

Unterschiedliche Art von REST-Anfragen

Hier werden wir jede einzelne Methode der REST-API zusammen mit den Sammlungen diskutieren.

MethodeBeschreibung
PATCHSehr ähnlich wie Put, aber es ist eher eine geringfügige Manipulation des Ressourceninhalts
ERHALTENStatuszeile, Antworttext, Kopfzeile usw. abrufen.
KOPFWie GET, jedoch nur Statuszeile und Header-Abschnitt abrufen
POSTFühren Sie eine Anforderung mit Anforderungsnutzdaten aus, hauptsächlich beim Erstellen eines Datensatzes auf dem Server
STELLENNützlich beim Bearbeiten / Aktualisieren der Ressource mithilfe von Request Payload
LÖSCHENLöscht Informationen zur Zielressource.
OPTIONENBeschreiben der Kommunikationsoptionen für die Zielressource

Hinweis: Es gibt so viele Methoden, die wir mit POSTMAN ausführen können, aber wir werden nur die folgenden Methoden mit POSTMAN diskutieren.

Wir werden eine Dummy-URL verwenden, um dies zu demonstrieren http://jsonplaceholder.typicode.com . Diese URL gibt uns die gewünschten Antworten, es erfolgt jedoch keine Erstellung oder Änderung auf dem Server.

# 1) GET

Anforderungsparameter:
Methode: GET
URI anfordern: http://jsonplaceholder.typicode.com/posts
Abfrageparameter: id = 3;

Antwort erhalten:
Antwortstatuscode: 200 OK

Antwortkörper ::

Antwortkörper

# 2) KOPF

Anforderungsparameter:
Methode: KOPF
URI anfordern: http://jsonplaceholder.typicode.com/posts

KOPF

# 3) POST

POST

# 4) PUT

STELLEN

LÖSCHEN

# 5) OPTIONEN

Anforderungsparameter:
Methode: OPTIONEN
URI anfordern: http://jsonplaceholder.typicode.com/
Header: Inhaltstyp = Anwendung / JSON

So testen Sie die Client-Server-Anwendung

OPTIONEN

# 6) PATCH

PATCH

Best Practices bei der Validierung einer REST-API

# 1) CRUD-Operationen

Besteht aus mindestens 4 bereitgestellten Methoden und sollte in der Web-API funktionieren.
GET, POST, PUT und DELETE.

# 2) Fehlerbehandlung

Mögliche Hinweise für die API-Konsumenten zum Fehler und warum er aufgetreten ist. Es sollte auch Fehlermeldungen auf granularer Ebene enthalten.

# 3) API-Versionierung

Verwenden Sie den Buchstaben 'v' in der URL, um die API-Version zu kennzeichnen. Zum Beispiel-

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

Zusätzlicher Parameter am Ende der URL

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

# 4) Filtern

Wenn der Benutzer angeben kann, wählen Sie die gewünschten Daten aus, anstatt sie alle gleichzeitig bereitzustellen.
/ contact / sam? name, alter, bezeichnung, büro
/ Kontakte? Limit = 25 & Offset = 20

# 5) Sicherheit

Zeitstempel in jeder API-Anforderung und -Antwort. Verwendung von access_token, um sicherzustellen, dass die API von den Vertrauenspersonen aufgerufen wird.

Wie erstelle ich ein Projekt in Eclipse?

# 6) Analytik

Wenn Sie Analytics in Ihrer REST-API haben, erhalten Sie einen guten Einblick in die getestete API, insbesondere wenn die Anzahl der abgerufenen Datensätze sehr hoch ist.

# 7) Dokumentation

Es ist eine ordnungsgemäße Dokumentation bereitzustellen, damit API-Konsumenten sie nutzen und die Dienste effektiv nutzen können.

# 8) URL-Struktur

Die URL-Struktur sollte einfach bleiben und ein Benutzer sollte in der Lage sein, den Domain-Namen leicht darüber zu lesen.

Zum Beispiel , https://api.testdomain.com.

Vorgänge, die über die Rest-API ausgeführt werden sollen, sollten ebenfalls sehr einfach zu verstehen und auszuführen sein.

Zum Beispiel für einen E-Mail-Client:

ERHALTEN: read / inbox / messages - Ruft die Liste aller Nachrichten im Posteingang ab
ERHALTEN: read / inbox / messages / 10 - Liest 10thNachricht im Posteingang
POST: create / inbox / folders - Erstellt einen neuen Ordner unter dem Posteingang
LÖSCHEN: Löschen / Spam / Nachrichten - Löschen Sie alle Nachrichten im Spam-Ordner
STELLEN: Ordner / Posteingang / Unterordner - Aktualisieren Sie die Informationen zum Unterordner unter Posteingang.

Fazit

Viele Unternehmen bevorzugen die Implementierung der REST-Web-API, da diese sehr einfach zu implementieren ist, weniger Standards und Regeln zu befolgen ist, leicht zugänglich, leicht und leicht zu verstehen ist. POSTMAN hat seine Vorteile bei Verwendung mit der RESTful-API aufgrund seiner benutzerfreundlichen Benutzeroberfläche, der einfachen Verwendung und des Tests, der schnelleren Antwortrate und der neuen RUNNER-Funktion.

Im nächsten Tutorial dieser Rest API Tutorial-Reihe werden wir die Testfälle automatisieren, die wir manuell ausgeführt haben.

Literatur-Empfehlungen

^