Qual è il punto / Utilizzo di scrivere solo le firme del metodo per un'API in .Net Web Api

0

Mi è stato chiesto di scrivere le firme per i metodi GET / POST / PUT dei punti finali dell'API. Sto attraversando un periodo difficile per capire quale sia il punto di questo. Il mio collega ha chiesto se potevo fare questo prima che entrassero e aggiungere l'implementazione. Significherebbe che tutto ciò che sto aggiungendo al controller Web Api è un mucchio di codice simile a questo?

GetSomething(string value1, string value2)

PutSomething(string value1, string value2)

PostSomething(guid value1, int value2, string value3)

Sto avendo difficoltà a capire quale sarebbe stato il punto. Dal momento che senza i tipi di ritorno e il codice non è utilizzabile se non sono stati dichiarati. Posso vedere questo essere utile nella documentazione però.

    
posta Stavros_S 08.04.2015 - 03:30
fonte

1 risposta

2

Il caso generale qui è l'identificazione della interfaccia esterna .

Dovrebbe essere possibile scrivere un'interfaccia per interagire con due sistemi o moduli, definire quali sono le firme del metodo, i formati dei dati, le condizioni preliminari / post-condizioni, ecc. con un'implementazione zero alle spalle.

Successivamente, i team separati lavorano su codice separato che utilizza tale interfaccia. Forse un team implementa il codice che fa funzionare l'interfaccia mentre un altro team implementa il codice che richiama l'interfaccia.

Le interfacce possono essere difficili. Lo spostamento di dati tra sistemi, formati, ecc. Può essere irto di problemi. Identificando le interfacce in anticipo, documentandole e avendo un sacco di tempo per testare, hai una possibilità migliore di avere un sistema pienamente funzionante nel momento in cui dovrebbe essere consegnato.

In questo caso specifico potrebbe essere vero che i tipi di restituzione o altri dettagli non sono ancora noti, ma è noto che si inizi a lavorare. È impossibile che qualcuno qui ci dica per certo visto che non siamo nella tua squadra al lavoro. Tuttavia, ho visto lo sviluppo dell'interfaccia procedere in questo modo in passato. Il cliente dice "abbiamo bisogno di un servizio web che aderisca a questa interfaccia, ma non siamo ancora sicuri di cosa restituire, abbiamo bisogno dei dati dei clienti, ma non abbiamo ancora un elenco di tutti i campi". Questo è abbastanza per iniziare. Ho una buona idea di cosa debba fare il codice dietro l'interfaccia, non sono sicuro dei piccoli dettagli che possono essere risolti in un secondo momento senza influire sul programma.

    
risposta data 08.04.2015 - 05:39
fonte

Leggi altre domande sui tag