ServiceStack e restituzione di un flusso

Question

Ho appena iniziato a utilizzare ServiceStack che è una straordinaria libreria.

Tuttavia, ho un requisito aziendale in cui dobbiamo restituire xml e json dove il xml deve essere nel formato specifico.

per esempio abbiamo clienti esistenti che si aspettano xml del formato:

<service name="service1" type="audio" .../> 

in modo sostanzialmente un gruppo di attributi.

So che ServiceStack utilizza concetti di DTO e utilizza DataContractSerializer che restituisce elementi xml anziché nel modulo sopra con attributi xml.

ho ancora voglia di utilizzare i DTOS per le richieste (di passaggio in application/xml o application/json nell'intestazione Accept) e posso quindi creare le mie stringhe XML o stringhe JSON e poi ritorno, se:

string result = "....xml or json string..."; 
return new MemoryStream(Encoding.UTF8.GetBytes(result)); 

dove la stringa del risultato può essere una stringa xml o una stringa json.

Ho notato nel violinista la risposta Content-Type come text/html.

Con l'approccio che sto utilizzando, sto violando i principi REST? Ci saranno problemi con il Content-Type così com'è attualmente (text/html)?

Se utilizzo questo approccio, risolve i requisiti aziendali.

Modifica

ho trovato che posso restituire un httpResult come:

return new HttpResult(
     new MemoryStream(Encoding.UTF8.GetBytes(result)), "application/xml"); 

che dà il corretto tipo di contenuto.

Quindi, è questo il modo giusto o avrò problemi se scenderò questa rotta?

Answer 1

Sì restituendo un IHttpResult consente di controllare il payload esatto, Content-Type e altre intestazioni HTTP come si desidera.

Inoltre, non sei limitato a restituire un flusso, ad esempio puoi utilizzare HttpResult per restituire una stringa xml con un diverso Content-Type.

Qui ci sono alcuni link che meglio dimostrano ciò che è possibile con i tipi di ritorno ServiceStack:

• How ServiceStack supports plain C# string, binary, stream, IStreamWriter, etc return types
• An example of using CORS to set global or per-service custom HTTP Headers
• Different ways of returning an Image from a ServiceStack service
• Multiple options for returning HTML

È possibile anche restituire un file statico usando un FileInfo oggetto, con un parametro facoltativo per restituire il file come allegato che chiederà all'utente di scaricare il file piuttosto che tentare di visualizzarlo nel browser con:

return new HttpResult(new FileInfo("~/static-response.xml"), asAttachment:true);