Come deve essere gestita la manipolazione della sottostruttura XML in un'API pubblica?

Question

Come deve essere gestita la manipolazione della sottostruttura XML in un'API pubblica?

#1 da (1 voti)
#2 da (0 voti)

2

Sto lavorando su un'API in cui una chiamata specifica sostituisce un sottoalbero di un documento XML, ovvero radicato in qualche elemento, con un'altra sottostruttura.

Le due opzioni che sto prendendo in considerazione per una risposta a questa chiamata sono:

Restituisce il DOM
Restituisce la sottostruttura modificata

Nell'interesse di sviluppare un'API standardizzata e stabile, mi piacerebbe farlo bene. C'è un modo migliore per gestire questo tipo di scenario? Quali sono i vantaggi e gli svantaggi di farlo in un modo rispetto all'altro? Avrebbe senso offrire entrambe queste opzioni ai consumatori di API?

api-design xml dom

posta porton 19.01.2012 - 17:56

fonte

2 risposte

Leggi altre domande sui tag api-design xml dom

È considerato "trasporto" se condivido il codice LGPL v3 modificato su GitHub? Open-source o closed-source per SaaS? [duplicare]

score 1 · Answer 1

Ci sono tre parti distinte.

Metodo 1 dell'API: individua una sottostruttura, radicata su qualche elemento.
Metodo API 2: crea una sottostruttura modificata e restituiscila.
Metodo API 3: Combina i primi due metodi API in un metodo API composito che individua e sostituisce una sottostruttura con un albero modificato.

Dovresti offrire tutti e tre.

score 0 · Answer 2

Idealmente, in base alla tua descrizione, il metodo non dovrebbe restituire nulla.

L'unica ragione per cui potresti voler restituire qualcosa è quando sai per certo che è un evento molto comune che i chiamanti devono usare quello che stai tornando subito. Guardalo dal punto di vista del chiamante. Ho bisogno dell'intero DOM o solo del ramo aggiornato? Se non puoi decidere facilmente, non restituire nulla.