Con un'API Web, elenco di oggetti o dizionario con elenco?

Question

Con un'API Web, elenco di oggetti o dizionario con elenco?

#1 da (0 voti)

-1

Scusa se la domanda è formulata male, non potrei pensare a un modo breve per spiegarlo senza esempi. La mia domanda è se stai ospitando un'API JSON, che è meglio:

[
  {
    "name": "Foo",
    "age": 1
  },
  {
    "name": "Bar",
    "age": 2
  }
]

o

{
  "Baz": [
    {
      "name": "Foo",
      "age": 1
    },
    {
      "name": "Bar",
      "age": 2
    }
  ]
}

La mia opinione personale è la seconda, tuttavia, non sono sicuro che sia inutile poiché non verranno aggiunte altre chiavi, almeno non ancora, ma immagino che dia flessibilità, in modo da non apportare alcuna modifica.

design api-design json json-schema

posta Orangutan_Codes 26.08.2018 - 14:01

fonte

1 risposta

Leggi altre domande sui tag design api-design json json-schema

Principi MVC / MVVM Come progetteresti l'astrazione / classe / i / i componente / i di un servizio / API di terze parti utilizzato nella tua applicazione?

score 0 · Answer 1

{
  "Baz": [
    {
      "name": "Foo",
      "age": 1
    },
    {
      "name": "Bar",
      "age": 2
    }
  ]
}

Questo non è un dizionario. È un oggetto con una proprietà lista. Queste sono due cose molto diverse.

Per quanto riguarda la domanda su quale dei due devi usare, dipende molto dal metodo e dai dati che intendi inviare.

Se il metodo è per esempio GetCompanies , allora ha senso restituire un elenco di società. Non hai bisogno di un oggetto wrapping.

Se intendi aggiungere alcuni metadati ai tuoi valori di ritorno (ad esempio se si tratta di dati impaginati, potresti voler inviare un "conteggio totale"), allora dovrai restituire un oggetto che contiene sia i metadati che i dati (elenco).