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

更新 MVC 项目

使用 Nuget获取最新的 Web API。

Project-右击-Manage Nuget Packages-搜索 Web API (Microsoft 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，添加新的路线。注意有过时的例子使用 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 是否正常工作:

到控制器文件夹-> Add new item-> Web API Controller Class。

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/Chrome 中进行测试，或者在 JavaScript 控制台中进行非 get 测试。

(通过 URL 中的控制器，它将在新的 Web API 控制器中调用 GET ()操作，它将根据 REST (例如 PUT/POST/GET/DELETE)自动映射到方法/操作。你不需要像在 MVC 中那样通过动作来调用它们) 网址直接为:

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

或者使用 jQuery 查询控制器。 运行项目，打开控制台(IE 中的 F12)并尝试运行一个 Ajax 查询

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