c# - 自定义 ASP.NET MVC 路由服务 ".json" ".xml"Style Urls

Question

我有一个正在处理的搜索 Api，它需要在一个 Html block 中返回搜索结果(使用客户端在其端定义的样式)。我还想在 Json 中返回结果，以供我们最终使用的 future Api 内容使用。目前，路线如下所示:

/api/1/search/json?param1=blah&param2=blah&etc
/api/1/search/html?param1=blah&param2=blah&etc

作为引用，这里的模式是/{area}/1/{controller}/{action}。

我喜欢一些我见过的 Api 的外观，它们以不同的格式返回结果，具体取决于它们在 url 中的“扩展名”，a la:

/api/1/search.json?param1=blah&param2=blah&etc

但是，我还没有弄清楚如何配置Asp.Net 的Mvc 路由来支持这种风格。 ApiAreaRegistration.cs中的大致路由是:

context.MapRoute(
    "Api_default",
    "Api/1/{controller}/{action}/{id}",
    new { action = "Index", id = UrlParameter.Optional });

我已经尝试了下面的，定义在一般的上面，但是不起作用:

//search api
context.MapRoute(
    "searchJson",
    "api/1/{controller}.{action}",
    new { controller = "SearchController" });

我将如何配置路由以启用 .format-style url？

Answer 1

context.MapRoute(
    "Api_default",
    "{area}/1/{controller}.{format}",
    new { action = "Index", id = UrlParameter.Optional });

可能是您想要的。然后你可以根据传入的参数返回不同的结果。

在 Api 区域的上下文中，SearchController 看起来像这样:

public class SearchController : Controller
{
    public ActionResult Index(string format, SearchModel search)
    {
        var results = searchFacade.SearchStuff(search);

        if(format.Equals("xml"))
            return Xml(results); //using an XmlResult or whatever
        if(format.Equals("html"))
            return View(results);
        return Json(results, JsonRequestBehavior.AllowGet);
    }
}