Web API Design für mobile App

Question

Ich brauche deine Hilfe. Ich denke über das Design der Backend-API für die mobile Anwendung. Sollte es REST-like oder etwas anderes sein?

Stellen Sie sich zum Beispiel vor, dass wir einige soziale Netzwerk-App erstellen. Es gibt eine Seite. Die Seite enthält:

1. Benutzerinformation (einige Felder von Benutzerdomäne)
2. Sammlung von Benutzernachrichten (nicht alle Felder von Nachrichtendomäne)
3. Zahlenwert - Anzahl der Gäste
4. Zahlenwert - zählen der Beiträge auf Benutzer Wand

ich sehe diese Optionen:

1. erstellen Endpunkte für alle 4-Domänen und 4-Anfragen rufen:

   GET /users/111?fields=id,name,email 
   GET /users/111/messages?fields=id,text,date_created 
   GET /users/111/guests/count 
   GET /users/111/posts/count?filter=news 
   

2. eine Methode erstellen für durch eine Anfrage

   GET /GetUserProfileInfo?userId=111 
   

3. Andere Optionen

all diese Informationen bekommen

Das denkst du? Welche Variante ist besser? Was ist mit Leistung? Was ist die beste Vorgehensweise dafür?

Danke.

Answer 1

Die Frage, die Sie stellen, ist ziemlich breit, aber hoffentlich kann dies Sie in die richtige Richtung bringen.

Ich würde mit einer RESTful-Schnittstelle gehen, ich habe Erfahrung mit REST und SOAP API von mobilen Apps verbinden und REST ist definitiv einfacher.

Wenn es um die Endpunkte zuerst geht, denke ich, dass Sie möglicherweise Option 1 erneut besuchen möchten. Zum Beispiel, wenn die Nachricht eine separate Ressource ist, möchten Sie vielleicht mit/Nachrichten gefolgt von Suchparametern wie /messages?user=111 gehen. Aber das hängt wirklich davon ab, welche Ressourcen Sie darstellen möchten.

Für die zweite Option würde ich mit einem Verb gehen, Sie können nur ein Benutzerprofil basierend auf einem Benutzer erstellen. Und da es verschiedene Aspekte eines Benutzers auf die gleiche Weise für jeden Benutzer kombiniert, ist es mehr als nur eine Abfrage oder eine Reihe von Abfragen. Ich würde mit so etwas gehen /user/111/profile.

Für die Leistung ist es wahrscheinlich besser, das Back-End (vielleicht eine Datenbank) alle Daten für ein Benutzerprofil zusammen zu bekommen und es mit einer Anfrage abzurufen. In dem Szenario, in dem Sie alle Bits mit separaten Anforderungen abrufen, hängen Sie mit dem Overhead der zusätzlichen HTTP-Anforderungen fest.

Die meisten dieser Entscheidungen hängen wirklich von den Anforderungen der API ab. Auch gibt this question/answer eine sehr detaillierte Erklärung und sollte Ihnen wahrscheinlich auch helfen.