API Ultime modifiche

0

Ho un'API REST pubblica per la creazione di nuovi record del profilo aziendale nel mio sistema. La richiesta stessa è simile a questa:

{
    "BusinessName" : "AName",
    "CurrencyCode" : "USD"
}

Puoi vedere che la proprietà CurrencyCode della richiesta è impostata su "USD" e la nostra documentazione dell'API REST afferma erroneamente che supportiamo "USD" o "EUR" come valori per questa proprietà.

Ecco il problema, negli ultimi colloqui con l'azienda è emerso chiaramente che, sebbene in futuro possiamo supportare più codici valuta, supportiamo solo "USD", e per di più non supporteremo mai la modifica del CurrencyCode sulla richiesta dal momento che è una limitazione nel nostro settore. Il nostro codice esistente ignora il valore di "CurrencyCode" sulla richiesta e lo codifica su "USD" in tutto il nostro sistema (codice legacy).

Quindi, a causa del fatto che non supporteremo mai CurrencyCode sulla richiesta, è stata presa la decisione di rimuoverlo. Quindi, andando avanti se "CurrencyCode" è fornito sulla richiesta, continueremo a ignorarlo in modo che l'utente non ottenga un errore e l'elaborazione continui come previsto finché passa "USD". Se tuttavia codificano contro la nostra attuale documentazione API e si aspettano che il supporto sia in atto, incontreranno problemi quando il loro software tenta di utilizzare "EUR" per il codice valuta.

Gli utenti odierni dell'API non hanno alcun modo di utilizzare il codice di valuta "Eur" perché la nostra applicazione ignora questo valore. Tuttavia, direi che questo è un bug e che la rimozione di questo valore senza alcun tipo di versioning dell'api è una cattiva pratica. Asserisco che questo dovrebbe essere considerato un cambiamento decisivo.

Quindi la domanda "La rimozione della proprietà" CurrencyCode "dalla richiesta è una modifica irrisolta anche se non la supportiamo oggi (bug) e non la supporteremo mai in futuro?"

    
posta P. Roe 08.10.2015 - 22:14
fonte

1 risposta

1

No.

Se il tuo codice ha effettivamente permesso ai consumatori pubblici di impostare il CurrencyCode in EUR , e ora non lo è, allora si tratta di un cambiamento significativo dal momento che stai cambiando la semantica. Se il tuo codice ha sempre utilizzato USD anche se si trattava di un bug , allora non si tratta di un errore.

Ma ignorare l'input stesso e modificare la documentazione per riflettere non è un cambiamento in sé e per sé.

    
risposta data 08.10.2015 - 22:36
fonte

Leggi altre domande sui tag