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

10

Capisco che quando si nominano URI RESTful è comunemente accettato l'uso di plurali per rappresentare raccolte di risorse. Sono curioso dell'argomento sull'uso di nomi singolari.

    
posta charness 17.06.2014 - 09:03
fonte

2 risposte

10

Alcune risorse contengono solo un singolo elemento. I buoni esempi sarebbero tutto ciò per cui non hai bisogno di un ID per scoprire quali dati rendere. Ad esempio, molto comune sarebbe la risorsa Login. Hai (dalla visualizzazione di utenti e browser) solo un singolo accesso. Puoi crearlo, puoi distruggerlo ma non avrai un'azione indice con diversi Login da cui scegliere.

Esempi simili potrebbero essere alcune pagine prevalentemente statiche come informazioni aziendali, impronte, moduli di contatto e cose simili che visualizzano solo un singolo elemento 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.

    
risposta data 17.06.2014 - 09:43
fonte
3

A causa:

  1. Le regole plurali inglesi come "ciliegie" non sono la cosa più bella da pensare durante lo sviluppo dell'API, in particolare quando l'inglese non è la tua lingua madre.
  2. A volte si desidera generare endpoint dal modello, che di solito è singolare. Non funziona bene con quanto sopra.
  3. L'argomento "di solito si inizia a interrogare da un Get per visualizzare un elenco" non si riferisce ad alcun caso d'uso reale. E finirai per interrogare singoli oggetti tanto quanto ancora di più di un elenco di elementi.
risposta data 30.08.2016 - 00:20
fonte

Leggi altre domande sui tag