Question

我正在尝试实现一个返回XML的MVC Rest API服务。

代码有点像这样：

public IEnumerable<XDocument> getXml(...)
        {
            XDocument responseXml = MakeHttpRequestAndGetResponseXML(...);
            return responseXml;
        }

但当然这不会奏效，只是我的尝试失败了。现在我想知道当我在XDocument对象中有XML响应时如何通过我的Web服务将其作为有效XML返回？

Answer 1

我过去通常所做的就是创建DTO代表您的XML并提供您的DTO属性序列化属性来描述XML：

[DataContract(Name = "Service", Namespace = "")]
public class ServiceApiDTO
{
    [DataMember(IsRequired = true, Order = 0, EmitDefaultValue = false)]
    public string Name { get; set; }

    [DataMember(IsRequired = true, Order = 1, EmitDefaultValue = false)]
    public string Description { get; set; }

    [DataMember(IsRequired = true, Order = 2, EmitDefaultValue = false)]
    public string Url { get; set; }

    [DataMember(IsRequired = false, Order = 3, EmitDefaultValue = false)]
    public DepartmentApiDTO Department { get; set; }

    [DataMember(IsRequired = false, Order = 4, EmitDefaultValue = false)]
    public string SLA { get; set; }

    [DataMember(IsRequired = false, Order = 5, EmitDefaultValue = false)]
    public string Cost { get; set; }

    [DataMember(IsRequired = true, Order = 6, EmitDefaultValue = false)]
    public ServiceStatusApiDTO CurrentStatus { get; set; }

    [DataMember(IsRequired = true, Order = 7, EmitDefaultValue = false)]
    public UserApiDTO CreatedBy { get; set; }
}

然后创建一个WebApiController以通过HttpGet公开这些DTO：

public class ServicesController : ApiController
{
    private readonly IServiceService _serviceService;

    public ServicesController(IServiceService serviceService)
    {
        _serviceService = serviceService;
    }

    //
    // GET: /api/Services/Service.{ext}/{url}

    [HttpGet]
    public ServiceApiDTO Service(string url)
    {
        var service = _serviceService.GetServiceByUrl(url);

        if (service == null)
        {
            var error = new HttpError(String.Format("No service found with URL = '{0}'", url));

            throw new HttpResponseException(Request.CreateErrorResponse(HttpStatusCode.NotFound, error));
        }

        var serviceDTO = Mapper.Map<Service, ServiceApiDTO>(service);

        return serviceDTO;
    }
}

然后告诉我的WebApiConfig处理Xml和Json扩展：

public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        config.Routes.MapHttpRoute(
            name: "ActionApi",
            routeTemplate: "api/{controller}/{action}.{ext}",
            defaults: new { ext = "xml|json" }
        );

        config.Routes.MapHttpRoute(
            name: "ActionApiServiceUrl",
            routeTemplate: "api/{controller}/{action}.{ext}/{url}",
            defaults: new { url = RouteParameter.Optional, ext = "xml|json" }
        );

        var jsonFormatter = config.Formatters.JsonFormatter;
        var xmlFormatter = config.Formatters.XmlFormatter;

        jsonFormatter.AddUriPathExtensionMapping("json", "application/json");
        xmlFormatter.AddUriPathExtensionMapping("xml", "text/xml");
    }
}

完成所有设置后，您可以像http://localhost/api/Services/Service.xml/urlParameter那样访问您的API，以响应为XML，或http://localhost/api/Services/Service.json/urlParameter作为JSON的响应。

这个例子通常是从我的一个应用程序中复制/粘贴的，但希望你能得到这个想法。

仅供参考，此处使用的一些技术是AutoMapper，用于从Domain Entity映射到DTO，而CastleWindsor用于将服务的依赖注入映射到WebApiController。

从MVC Rest API发送XML响应

1 个答案: