如何对Web API添加到现有的ASP.NET MVC(5)Web应用程序项目?如何对Web API

2019-05-12 17:58发布

假设你忘了剔作出新的MVC(5)项目当Web API复选框(它添加到项目),你需要做的添加Web API,并得到它的工作是什么?

有一堆迁移的问题,但没有一个似乎对添加Web API到MVC 5项目的完整和最新步骤,它似乎已经从一些老的回答改变。

网页API加入MVC 4

添加GlobalConfiguration.Configure(WebApiConfig.Register)MVC 4

Answer 1:

更新MVC项目

使用的NuGet来获取最新的Web API。

项目 - 右键 - 管理的NuGet软件包 - 搜索Web API(微软的ASP.NET Web API ...),并把它安装到你的MVC项目。

然后,你仍然需要得到的Web API路由工作。 从微软的配置的ASP.NET Web API 2

添加WebApiConfig.cs到App_Start /文件夹

using System.Web.Http;

namespace WebApplication1
{
    public static class WebApiConfig
    {
        public static void Register(HttpConfiguration config)
        {
            // TODO: Add any additional configuration code.

            // Web API routes
            config.MapHttpAttributeRoutes();

            config.Routes.MapHttpRoute(
                name: "DefaultApi",
                routeTemplate: "api/{controller}/{id}",
                defaults: new { id = RouteParameter.Optional }
            );

        // WebAPI when dealing with JSON & JavaScript!
        // Setup json serialization to serialize classes to camel (std. Json format)
        var formatter = GlobalConfiguration.Configuration.Formatters.JsonFormatter;
        formatter.SerializerSettings.ContractResolver =
            new Newtonsoft.Json.Serialization.CamelCasePropertyNamesContractResolver();
        }
    }
}

如果你有一个MVC项目将有Global.asax.cs中 ,添加了新的途径。 在Global.asax.cs中路线的顺序是至关重要的。 注意:还有一些采用过时的例子WebApiConfig.Register

加入这一行的global.asax.cs: GlobalConfiguration.Configure(WebApiConfig.Register);

protected void Application_Start()
{
    // Default stuff
    AreaRegistration.RegisterAllAreas();

    // Manually installed WebAPI 2.2 after making an MVC project.
    GlobalConfiguration.Configure(WebApiConfig.Register); // NEW way
    //WebApiConfig.Register(GlobalConfiguration.Configuration); // DEPRECATED

    // Default stuff
    FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
    RouteConfig.RegisterRoutes(RouteTable.Routes);
    BundleConfig.RegisterBundles(BundleTable.Bundles);
}

的WebAPI帮助

为了得到( 非常 ) 有用的WebAPI帮助页面 ,安装WebAPI.HelpPage。 见http://channel9.msdn.com/Events/Build/2014/3-644 (〜42分钟)为它做什么。 它看起来非常有帮助!

的NuGet控制台: Install-Package Microsoft.AspNet.WebApi.HelpPage

要验证的WebAPI的工作:

到控制器的文件夹 - >添加新项 - >网络API控制器类。

public class TestController : ApiController
{
    //public TestController() { }

    // GET api/<controller>
    public IEnumerable<string> Get()
    {
        return new string[] { "value1", "value2" };
    }

    // GET api/<controller>/5
    public string Get(int id)
    {
        return "value";
    }
    //...
}

现在你可以在IE / FF /铬试验和往常一样,或在JavaScript控制台非得到测试。

(只需在它会调用在新的Web API控制器的GET()动作的URL控制器,它会自动映射到依赖于REST方法/措施如PUT / POST / GET / DELETE。你并不需要调用他们通过像MVC操作)直接的网址:

http://localhost:PORT/api/CONTROLLERNAME/

或者使用jQuery查询控制器。 运行该项目,打开控制台(F12在IE浏览器),并尝试运行一个Ajax查询。 (请检查您PORT&CONTROLLERNAME)

$.get( "http://localhost:PORT/api/CONTROLLERNAME/", function( data ) {
    //$( ".result" ).html( data );
    alert( "Get data received:" + data);
});

附注:有一些优点/缺点在一个项目中结合MVC和Web API时要考虑

的WebAPI帮助验证: http://localhost:PORT/help



文章来源: How to add Web API to an existing ASP.NET MVC (5) Web Application project?