将RazorEngine应用于一些WebApi响应

时间:2014-02-03 15:54:51

标签: asp.net-web-api razorengine

我有一个使用WebApi + signalR +自托管的应用程序。 我添加了RazorEngine以使用razor语法来使用cshtml视图。

这有效(请参阅下面的简化代码),但这会导致所有WebApi调用尝试通过views + razor生成HTML。我想要一些WebAPi,它只是向客户端的请求发送普通的XML或JSON。例如。也许,一个api控制器使用普通的XML / JSON和一个api控制器来使用vews / razor / cshtml生成响应

我有什么想法会这样做吗?

    class Program  {
        static void Main(string[] args)  {  
            using (WebApp.Start<Startup>(url: "http://localhost:8080/")) {
                Console.WriteLine("Started");
                Console.ReadKey();
            }
        }
    }


    public class Startup {
        public void Configuration(IAppBuilder app)  {
            HttpConfiguration config = new HttpConfiguration();
            config.Routes.MapHttpRoute(
                  name: "DefaultApi",
                  routeTemplate: "api/{controller}/{id}",
                  defaults: new { id = RouteParameter.Optional }
              );
            app.UseWebApi(config);
            app.UseCors(CorsOptions.AllowAll);
            app.MapSignalR();

            // RazorEngine - so WebApi can use views+razor
            GlobalConfiguration.Configuration.Formatters.Add(new HtmlMediaTypeViewFormatter());
            GlobalViews.DefaultViewParser = new RazorViewParser();
            GlobalViews.DefaultViewLocator = new RazorViewLocator();
            config.Formatters.Add(new HtmlMediaTypeViewFormatter());
        }
    }



    public class HomeController : ApiController {

        //http://localhost:8080/api/home
        public Value GetValues()  {
            return new Value() { Numbers = new int[] { 1, 2, 3 } };
        }

        //want to return just XML and not go via the view+razor+cshtml
        //Works ok for normal self-hosted webapi, but cant get to work for views+razor
        //http:localhost:8080/api/home/1
        public String Get2(int id)  {
            return "Get2() returns a string";
        }

    }


    [View("Home")]     //need this line to get the webApi views+razor to work
    public class Value  {
        public int[] Numbers { get; set; }
    }

... Home.cshtml

<html>
<head>
    <title>Hello World!</title>
</head>
<body>
    <h1>Hello World! ..</h1>
    <ul>
        @foreach (var value in Model.Numbers)
        {
            <li>@value</li>
        }
    </ul>
</body>
</html> 

1 个答案:

答案 0 :(得分:2)

有几种方法。

A)您可以让客户端发送正确的接受标头,以便Web API协商正确的格式化程序。

b)您可以基于每个控制器自定义配置。这将允许您仅为要返回HTML的控制器定义HTML格式化程序。 以下是每个控制器配置的链接:http://blogs.msdn.com/b/jmstall/archive/2012/05/11/per-controller-configuration-in-webapi.aspx

c)不要为HTML控制器使用返回管道连接。返回HttpResposeMessage并显式设置Content属性。

 public class HomeController : ApiController {

    //http://localhost:8080/api/home
    public HttpResponseMessage GetValues()  {
        var value = Value() { Numbers = new int[] { 1, 2, 3 } };

        return new HttpResponseMessage() {
                 Content = new ObjectContent<Value>(value, new HtmlMediaTypeViewFormatter())
             };
    }

    //want to return just XML and not go via the view+razor+cshtml
    //Works ok for normal self-hosted webapi, but cant get to work for views+razor
    //http:localhost:8080/api/home/1
    public String Get2(int id)  {
        return "Get2() returns a string";
    }

}