Diese Kernwissenspunkte müssen in der Front-End- und Backend-Kommunikation beherrscht werden!

Was ist erholsam?

restful ist derzeit die beliebteste Spezifikation für das Schnittstellendesign. Es handelt sich um eine Spezifikation, die sowohl das Frontend als auch das Backend kennen muss. Diese Spezifikation definiert das

Protokoll in jedem Prozess der Schnittstellenentwicklung Der Client interagiert mit dem Backend über die API. Im Prozess der Enddienstkommunikation sollte das HTTPS-Protokoll verwendet werden.

Domänenname

API sollte unter einem dedizierten Domänennamen bereitgestellt und so einfach wie möglich gehalten werden. Wenn Sie sicher sind, dass die API sehr einfach ist und nicht weiter erweitert wird, können Sie erwägen, sie unter dem Hauptdomänennamen zu platzieren. Hier sind zwei gängige URL-Root-Beispiele:

api.example.com/* Ein separater Subdomänenname wird für den Zugriff auf die Schnittstelle verwendet

example.com/api/* Ein separater Bereich unter dem Hauptdomänennamen

• Versionierung

Alle APIs müssen abwärtskompatibel bleiben und gleichzeitig sicherstellen, dass alte Versionen vorhanden sind der APIs sind noch verfügbar. Daher sollte dafür eine Versionsunterstützung bereitgestellt werden ein Substantiv und muss Es ist die PluralformSie müssen zuerst URLs vom Typ Restful verwenden

URL muss leicht lesbar sein

URL darf die Serverarchitektur nicht offenlegen

Angaben dazu, ob die URL Bindestriche (-) verwenden muss oder Unterstriche (_), es ist nicht zwingend erforderlich, aber ein Stil muss entsprechend der Teamsituation vereinheitlicht werden

https://api.example.com/zoos
• https://api.example.com/ Tiere
• https://api.example.com /zoos/{zoo}/animals
• https://api.example.com/animal_types
• https://api.example.com/employees

Verb (Methode der Anforderungsmethode)

• für Ressourcen Spezifische Operationstypen, dargestellt durch HTTP-Verben. Es gibt fünf häufig verwendete HTTP-Verben (die entsprechenden SQL-Befehle stehen in Klammern).
• GET (SELECT): Holen Sie sich die Ressource (ein oder mehrere Elemente) vom Server.
• POST (CREATE): Erstellen Sie eine neue Ressource auf dem Server.
• PUT (UPDATE): Ressourcen auf dem Server aktualisieren (der Client stellt die komplett geänderten Ressourcen bereit).
• PATCH (UPDATE): Update im Server-Update-Ressourcenteil (Client stellt geänderte Attribute bereit).

DELETE (DELETE): Eine Ressource vom Server löschen.

URL-Parameter

• Alle URL-Parameter müssen vollständig in Kleinbuchstaben geschrieben sein und die Parameterform „Unterstrich“ verwenden.
Paging-Parameter müssen auf Seite und Seitengröße festgelegt sein Code.
• Müssen Daten im JSON-Format zurückgeben.
Alle Fehler müssen im gleichen Fehlerformat vorliegen.
• Allgemeine Statuscodes

1xx bedeutet, dass die Anfrage angenommen wurde und weiter verarbeitet werden muss. Sie wird im Allgemeinen nicht in der API angezeigt.

2xx Die Anfrage war erfolgreich und der Antwortheader oder Datentext wurde erwartet Die Anforderung wird mit dieser Antwort zurückgegeben

200 Der Server gibt die vom Benutzer angeforderten Daten erfolgreich zurück

201 Der Benutzer erstellt oder ändert Daten erfolgreich

202 Zeigt an, dass eine Anforderung im Hintergrund in die Warteschlange gestellt wurde (es gibt keine Rückgabe). Wert, wenn erfolgreich, ist er asynchron)204 Erfolgreich gelöscht

3xx-Umleitung

4xx Fehler aus Client-Gründen404 Die angeforderte Schnittstelle existiert nicht, der Fehlertyp (die Anforderungsadresse ist falsch)

401 Der Benutzer ist nicht angemeldet
• 403 Der Benutzer ist angemeldet, hat aber keine Zugriffsberechtigung
• 422 Die Client-Parameter sind falsch, Überprüfungsfehler
  • 429 Anforderungslimit überschritten
  • 5xx Serverseitiger Fehler Gründe
  • 500 Der Server ist auf eine unerwartete Situation gestoßen, die dazu führte, dass er die Verarbeitung der Anfrage nicht abschließen konnte, und der Servercode meldete einen Fehler
503 Serverwartung Unter
• 504 Timeout-Anruf
• • falsch Format

  'message' => ':message',          // 错误的具体描述
  'errors' => ':errors',            // 参数的具体错误描述，422 等状态提供
  'code' => ':code',                // 业务自定义的异常码
  'status_code' => ':status_code',  // http状态码
  'debug' => ':debug',              // debug 信息，非生产环境提供

• Was ist eine Nachricht?

HTTP-Nachrichten werden zum Austausch von Informationen bei HTTP-Anfragen und -Antworten verwendet. Nachrichten fließen vom Client in den Server. Nachrichten werden in zwei Kategorien unterteilt: Anforderungsnachrichten und Antwortnachrichten. Die grundlegenden Nachrichtenstrukturen von Anforderungs- und Antwortnachrichten sind gleich und bestehen aus drei Teilen:

Startzeile: Beschreiben Sie die Nachricht
• Header: Einige Attribute
• Body: Daten [Optional]

axios

Kompatibel mit Browsern und Knotenservern XMLHttpRequests aus dem Browser erstellen

Aus node.js http-Anfrage erstellen

Support Promise API Support Abfangen von Anfragen und Antworten

Anfragedaten und Antwortdaten konvertieren

Anfrage abbrechen

JSON-Daten automatisch konvertieren

Client unterstützt die Abwehr von XSRF

Komm schon, Fremde! (Ich hoffe, ihr seid keine Fremden, wenn ihr kommt und geht, hoffe ich Hilfreich für Sie)

Das obige ist der detaillierte Inhalt vonDiese Kernwissenspunkte müssen in der Front-End- und Backend-Kommunikation beherrscht werden!. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!