Was ist das Argument für einzelne Substantive bei der Benennung von RESTful API-Ressourcen?

12

Ich verstehe, dass bei der Benennung von RESTful-URIs die Verwendung von Pluralzahlen zur Darstellung von Ressourcensammlungen allgemein akzeptiert wird. Ich bin neugierig auf das Argument, stattdessen einzelne Substantive zu verwenden.

Nächstenliebe
quelle
vielleicht ist da nicht alles eine sammlung?
Jwenting
Wäre da nicht eine Singleton-Ressource ins Spiel gekommen?
Nächstenliebe

Antworten:

12

Einige Ressourcen enthalten nur ein einzelnes Element. Gute Beispiele wären alles, für das Sie keine ID benötigen, um herauszufinden, welche Daten gerendert werden sollen. Sehr verbreitet wäre beispielsweise die Login-Ressource. Sie haben (aus der Sicht der Benutzer und Browser) nur eine einzige Anmeldung. Sie können es erstellen, Sie können es zerstören, aber Sie haben keine Indexaktion mit mehreren Logins zur Auswahl.

Ähnliche Beispiele wären zumeist statische Seiten wie Unternehmensinformationen, Abdrücke, Kontaktformulare und ähnliche Dinge, die nur ein einzelnes Element anzeigen oder nur eine einzelne Erstellungsaktion zulassen.

Es könnte diskutiert werden, ob die Verwendung einzelner Substantive die Lesbarkeit des Codes wirklich verbessert.

thorsten müller
quelle
5

Weil:

  1. Englische Pluralregeln wie "Kirschen" sind nicht das Schönste, was Sie bei der Entwicklung von APIs beachten sollten, besonders wenn Englisch nicht Ihre Muttersprache ist.
  2. Manchmal möchten Sie einen Endpunkt aus dem Modell generieren, das normalerweise singulär ist. Es spielt sich nicht gut mit den oben genannten.
  3. Das Argument "Normalerweise beginnen Sie mit einer Abfrage, um eine Liste anzuzeigen" bezieht sich nicht auf einen tatsächlichen Anwendungsfall. Und Sie werden am Ende einzelne Elemente genauso oft und sogar mehr als eine Liste von Elementen abfragen.
Benoit
quelle