Qual è l'argomento per i nomi singolari nella denominazione delle risorse API RESTful?


12

Comprendo che quando si nominano gli URI RESTful è comunemente accettato l'uso di plurali per rappresentare raccolte di risorse. Sono curioso dell'argomento per usare invece i nomi singolari.


forse perché non tutto è una collezione?
jwenting

Non è qui che entrerebbe in gioco una risorsa singleton?
Beneficenza,

Risposte:


12

Alcune risorse contengono solo un singolo elemento. Un buon esempio potrebbe essere tutto per il quale non è necessario un ID per scoprire quali dati visualizzare. Molto comune, ad esempio, sarebbe la risorsa di accesso. Hai (dalla vista utenti e browser) un solo accesso. Puoi crearlo, puoi distruggerlo ma non avrai un'azione indicizzata con diversi accessi tra cui scegliere.

Esempi simili sarebbero alcune pagine per lo più statiche come informazioni aziendali, impronte, moduli di contatto e cose simili che visualizzano solo un singolo articolo o consentono solo una singola azione di creazione.

Potrebbe essere una questione di discussione se l'uso di nomi singolari aggiunge davvero molto alla leggibilità del codice.


5

Perché:

  1. Le regole del plurale inglese come "ciliegie" non sono la cosa più bella a cui pensare durante lo sviluppo di API, in particolare quando l'inglese non è la tua lingua madre.
  2. A volte si desidera generare un endpoint dal modello, che di solito è singolare. Non gioca bene con quanto sopra.
  3. L'argomento "di solito si avvia la query da un Get per visualizzare un elenco" non fa riferimento a nessun caso d'uso reale. E finirai per interrogare singoli elementi tanto quanto e persino più di un elenco di elementi.
Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.