2013-03-12 18 views
19

Ho un metodo Web Api che dovrebbe restituire un dati XML ma restituisce stringa:Come restituire dati Xml da un metodo API Web?

public class HealthCheckController : ApiController 
    {  
     [HttpGet] 
     public string Index() 
     { 
      var healthCheckReport = new HealthCheckReport(); 

      return healthCheckReport.ToXml(); 
     } 
    } 

Restituisce:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/"> 
<myroot><mynode></mynode></myroot> 
</string> 

e ho aggiunto questa mappatura:

config.Routes.MapHttpRoute(
       name: "HealthCheck", 
       routeTemplate: "healthcheck", 
       defaults: new 
       { 
        controller = "HealthCheck", 
        action = "Index" 
       }); 

Come fare restituire solo i bit xml:

<myroot><mynode></mynode></myroot> 

Se stavo usando solo MVC, che potrebbe utilizzare il seguito, ma API Web non supporta "Contenuto":

[HttpGet] 
     public ActionResult Index() 
     { 
      var healthCheckReport = new HealthCheckReport(); 

      return Content(healthCheckReport.ToXml(), "text/xml"); 
     } 

Ho anche aggiunto i codici di seguito per la classe WebApiConfig:

config.Formatters.Remove(config.Formatters.JsonFormatter); 
config.Formatters.XmlFormatter.UseXmlSerializer = true; 
+1

puoi semplicemente restituire l'istanza HealthCheckReport, e lasciare che il formattatore XML fare la serializzazione ? In questo momento, stai serializzando su XML nel tuo controller e quindi passando quella stringa al formattatore XML. Quindi il formattatore XML serializza la stringa in XML. –

risposta

39

Il modo più rapido è questo,

public class HealthCheckController : ApiController 
{  
    [HttpGet] 
    public HttpResponseMessage Index() 
    { 
     var healthCheckReport = new HealthCheckReport(); 

     return new HttpResponseMessage() {Content = new StringContent(healthCheckReport.ToXml(), Encoding.UTF8, "application/xml")}; 
    } 
} 

ma è anche molto facile da costruire una nuova classe che deriva da XmlContent HttpContent a suppor t XmlDocument o XDocument direttamente. per esempio.

public class XmlContent : HttpContent 
{ 
    private readonly MemoryStream _Stream = new MemoryStream(); 

    public XmlContent(XmlDocument document) { 
     document.Save(_Stream); 
      _Stream.Position = 0; 
     Headers.ContentType = new MediaTypeHeaderValue("application/xml"); 
    } 

    protected override Task SerializeToStreamAsync(Stream stream, System.Net.TransportContext context) { 

     _Stream.CopyTo(stream); 

     var tcs = new TaskCompletionSource<object>(); 
     tcs.SetResult(null); 
     return tcs.Task; 
    } 

    protected override bool TryComputeLength(out long length) { 
     length = _Stream.Length; 
     return true; 
    } 
} 

ed è possibile utilizzare proprio come si usa StreamContent o StringContent, tranne che accetta un XmlDocument,

public class HealthCheckController : ApiController 
{  
    [HttpGet] 
    public HttpResponseMessage Index() 
    { 
     var healthCheckReport = new HealthCheckReport(); 

     return new HttpResponseMessage() { 
      RequestMessage = Request, 
      Content = new XmlContent(healthCheckReport.ToXmlDocument()) }; 
    } 
} 
+0

Come viene utilizzata la classe XmlContent? Deve registrarsi da qualche parte? –

Problemi correlati