讓ASP.NET Web API支援$format參數的方法

標籤：

在不使用OData的情況下，也可以讓ASP.NET Web API支援$format參數，只要在WebApiConfig裡添加如下三行紅色粗體代碼即可： 

using System;using System.Collections.Generic;using System.Linq;using System.Web.Http;using System.Net.Http.Formatting;namespace ProjectManagementWebAppV4{    public static class WebApiConfig    {        public static void Register(HttpConfiguration config)        {            // Web API configuration and services            // Web API routes            config.MapHttpAttributeRoutes();            config.Routes.MapHttpRoute(                name: "DefaultApi",                routeTemplate: "api/{controller}/{id}",                defaults: new { id = RouteParameter.Optional }            );            config.Formatters.JsonFormatter.AddQueryStringMapping("$format", "json", "application/json");            config.Formatters.XmlFormatter.AddQueryStringMapping("$format", "xml", "application/xml");        }    }}

首先是：using System.Net.Http.Formatting; 其實就是System.Net.Http.Formatting.dll。

然後是：config.Formatters.JsonFormatter.AddQueryStringMapping("$format", "json", "application/json");
            config.Formatters.XmlFormatter.AddQueryStringMapping("$format", "xml", "application/xml");

之後就大功告成了！

這樣，無論是在IE中，還是在chrome中，只要在url後面添加$format=json或$format=xml參數，瀏覽器就可以返回相應格式的資料了，也不必改Http請求Header中的Accept媒體類型了，這樣測試WebAPI時更方便了。

URL如下：

http://localhost:port/api/ProjectManagent?$format=json

http://localhost:port/api/ProjectManagent?$format=xml

 

Demo原始碼下載： 原代碼下載

參考資料：https://code.msdn.microsoft.com/Support-format-in-ASPNET-e3785b2a

讓ASP.NET Web API支援$format參數的方法