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

How to add Web API to an existing ASP.NET MVC 4 Web Application project?

我希望将ASP.NET Web API添加到在Visual Studio 2012中开发的ASP.NET MVC 4 Web应用程序项目中。我必须执行哪些步骤才能向项目添加功能正常的Web API？我知道我需要一个从apicontroller派生的控制器，但这就是我所知道的。

如果需要提供更多详细信息，请通知我。

我需要执行的步骤是：

添加对System.Web.Http.WebHost的引用。

添加App_Start\WebApiConfig.cs(参见下面的代码段)。

在Global.asax.cs中导入命名空间System.Web.Http。

在注册默认的Web应用程序路由之前，在MvcApplication.Application_Start()中(在文件Global.asax.cs中)调用WebApiConfig.Register(GlobalConfiguration.Configuration)，否则将优先。

增加从System.Web.Http.ApiController派生的控制器。

然后，我可以从教程(您的第一个ASP.NET Web API)学到足够的知识来定义我的API控制器。

应用程序webapiconfig.cs：

1
2
3
4
5
6
7
8
9
10

using System.Web.Http;

class WebApiConfig
{
public static void Register(HttpConfiguration configuration)
{
configuration.Routes.MapHttpRoute("API Default","api/{controller}/{id}",
new { id = RouteParameter.Optional });
}
}

Global.asax.cs：

1
2
3
4
5
6
7
8
9
10
11
12
13

using System.Web.Http;

...

protected void Application_Start()
{
AreaRegistration.RegisterAllAreas();

RegisterGlobalFilters(GlobalFilters.Filters);
WebApiConfig.Register(GlobalConfiguration.Configuration);
RegisterRoutes(RouteTable.Routes);
BundleConfig.RegisterBundles(BundleTable.Bundles);
}

更新时间：2015年10月16日：

在Word中，必须安装nuget包microsoft.aspnet.webapi才能使上述软件正常工作。

相关讨论

这真的很有帮助。我还得加上一个对System.Net.Http的引用，但除此之外，它还真是魅力四射！
很酷，我刚刚通过创建一个新的MVC4互联网项目进行了测试，它已经引用了System.Net.Http。所以你的情况可能有点不同？
是的，我的是一个MVC 3应用程序，我手动更新到了MVC 4。不知道这是不是原因。
那是我的猜测。
我还将一个项目从MVC3升级到了4，还需要添加对system.web.http的引用。
我创建了一个"互联网应用程序"，似乎所有这一切都是为您开箱即用。
有人知道这是否会允许您在项目中创建一个名为"api"的等效新区域，该区域有自己独特的控制器，并且类似地隐藏在api目录下？然后，您可以在通常的区域拥有用于网站的标准Web控制器，并在API下拥有一个完全不同的集合。哇，我真希望这是有道理的。
@longda这个答案中的web api路由意味着对/api/*的请求被路由到api控制器。我认为，如果将API控制器放在子目录("api")中并不重要，尽管我在我的项目中已经这样做了。你自己试试。
您现在可以使用nuget，随时掌握发生的任何更改！nuget.org/packages/microsoft.aspnet.webapi
@隆达虽然不需要在"api"区域，但它在HTML助手中的表现更好——好吧，有点。当涉及到imho地区时，帮助者本身需要一些帮助。
这种方法似乎也适用于MVC 5
@Aknuds1，这是一篇很好的文章，但我肯定做了一些错误的事情。我正在努力使它在MVC 5上运行，但没有成功。我按照这个解释做了这个，然后右键单击"控制器"，并添加了"WebAPI 2控制器与操作，使用实体框架"，在这里我选择了我的模型类和数据库上下文。一切都很好，但当我尝试访问/api/(mycontroller)时…繁荣：404
@很抱歉，我没有试过MVC 5，也许线路已经改变了？您确定要使用正确的URL访问控制器吗？也就是说，如果它名为MyController，您应该以/api/my访问它。
@Aknuds1，我就是这么做的…一定是别的东西…您认为它与我的配置ssl=true(https)有关吗？谢谢
@我真的不知道。我的建议是创建一个新的WebAPI2项目，看看它是如何工作的。
谢谢，没问题！
请务必注意"在注册默认的Web应用程序路由之前，否则将优先"注释，否则您将得到一个HTTP 404的"找不到资源"错误，即使您可能已经正确连接了其他所有内容。
在将Web API注册更改为：globalconfiguration.configure(webapiconfig.register)之前，我不会让它工作；
为什么"api/controller/id"不是"api/controller/action/id"？
@我记得，使用Web API控制器的codegrue表示(rest)资源，例如用户，而操作不适合该方案。例如，您可以为/api/users/1发出get请求，这意味着要获取用户1。
也许WebApiConfig.Register(GlobalConfiguration.Configuration);必须在AreaRegistration.RegisterAllAreas();之后。
@路易斯古维娅，我想是要迟到了，但如果这是我所拥有的，其他人可能会更快地解决问题。globalconfiguration.configure(webapiconfig.register)；在global.asax中，位于routeconfig.register routes(routetable.routes)之前；
你好，马克西姆，是的，我知道，也许你是在检查了我自己的答案后修好的：)stackoverflow.com/questions/22401403/&hellip；
除了上述步骤外，我还必须运行以下"安装包Microsoft.aspnet.webapi"才能使其正常工作。谢谢
有授权吗？
我还需要global configuration.configuration.ensureInitialized()；在全局asax结束时
webhost包含globalconfiguration stackoverflow.com/a/21402541/1175496
按照上面的步骤，除了一个问题，效果很好。我遇到的问题的答案是：确保httpconfiguration.ensureReinitialized()。
谢谢你的帮助。
就像一个魅力…很好的解释
我在"添加引用"窗口中找不到system.web.http.webhost。我不得不用pmc命令：Install-Package Microsoft.AspNet.WebApi.WebHost。感谢您分享@aknuds1。

更新11/22/2013-这是最新的WebAPI包：

1	Install-Package Microsoft.AspNet.WebApi

原始答案(这是一个较旧的WebAPI包)

1	Install-Package AspNetWebApi

更多细节。

相关讨论

在我的MVC 5项目中添加WebAPI。

打开Nuget Package Manager控制台并运行

1	PM> Install-Package Microsoft.AspNet.WebApi

添加对System.Web.Routing、System.Web.Net和System.Net.Httpdll的引用(如果还没有)

右键单击控制器文件夹>添加新项目>Web>添加Web API控制器

web.config将根据vs进行相应修改

如果还没有添加Application_Start方法

1
2
3
4
5

protected void Application_Start()
{
//this should be line #1 in this method
GlobalConfiguration.Configure(WebApiConfig.Register);
}

添加以下类(我添加在global.asax.cs文件中)

1
2
3
4
5
6
7
8
9
10
11
12
13
14

public static class WebApiConfig
{
public static void Register(HttpConfiguration config)
{
// Web API routes
config.MapHttpAttributeRoutes();

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

相应地修改Web API方法

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

namespace <Your.NameSpace.Here>
{
public class VSController : ApiController
{
// GET api/<controller> : url to use => api/vs
public string Get()
{
return"Hi from web api controller";
}

// GET api/<controller>/5 : url to use => api/vs/5
public string Get(int id)
{
return (id + 1).ToString();
}
}
}

重建和测试

构建一个简单的HTML页面

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

<html xmlns="http://www.w3.org/1999/xhtml">
<head>

<script src="../<path_to_jquery>/jquery-1.9.1.min.js">
<script type="text/javascript">
var uri = '/api/vs';
$(document).ready(function () {
$.getJSON(uri)
.done(function (data) {
alert('got: ' + data);
});

$.ajax({
url: '/api/vs/5',
async: true,
success: function (data) {
alert('seccess1');
var res = parseInt(data);
alert('got res=' + res);
}
});
});

</head>
<body>
....
</body>
</html>

相关讨论

只要在Controllers文件夹下添加一个"WebAPI控制器"，Visual Studio就会自动处理依赖关系；

Visual Studio has added the full set of dependencies for ASP.NET Web
API 2 to project 'MyTestProject'.

The Global.asax.cs file in the project may require additional changes
to enable ASP.NET Web API.

Add the following namespace references:

using System.Web.Http;
using System.Web.Routing;

If the code does not already define an Application_Start method, add the following method:

protected void Application_Start()
{
}

Add the following lines to the beginning of the Application_Start method:

GlobalConfiguration.Configure(WebApiConfig.Register);

相关讨论

您可以从nuget安装，如下图所示：

enter image description here

或者，在包管理器控制台上运行以下命令行：

1	Install-Package Microsoft.AspNet.WebApi

相关讨论

在您开始合并MVC和Web API项目之前，我建议您先阅读一下缺点和优点，将它们作为不同的项目进行分离。一件非常重要的事情(我自己的)是认证系统，这是完全不同的。

如果需要在MVC和Web API上使用经过身份验证的请求，则需要记住Web API是RESTful(不需要保留会话、简单HTTP请求等)，但MVC不是。

要了解实现的差异，只需在Visual Studio 2013中使用模板创建两个不同的项目：一个用于MVC，另一个用于Web API(不要忘记在创建过程中打开"单个身份验证")。在authencationcontrollers中，您会看到很多不同之处。

所以，要注意。

注：这只是上述答案的缩写。

打开Nuget Package Manager控制台并运行

1	PM> Install-Package Microsoft.AspNet.WebApi

添加对System.Web.Routing、System.Web.Net和System.Net.Httpdll的引用(如果还没有)

添加以下类

1
2
3
4
5
6
7
8
9
10
11
12
13
14

如果还没有添加Application_Start方法(在global.asax.cs文件中)

1
2
3
4
5

protected void Application_Start()
{
//this should be line #1 in this method
GlobalConfiguration.Configure(WebApiConfig.Register);
}

右键单击控制器文件夹>添加新项目>Web>添加Web API控制器

1
2
3
4
5
6
7
8
9
10
11

namespace <Your.NameSpace.Here>
{
public class VSController : ApiController
{
// GET api/<controller> : url to use => api/vs
public string Get()
{
return"Hi from web api controller";
}
}
}

相关讨论

上述解决方案完全有效。我更喜欢在选择项目模板时选择Web API选项，如下图所示

注意：该解决方案适用于Visual Studio 2013或更高版本。最初的问题是在2012年提出的，现在是2016年，因此添加了一个解决方案Visual Studio 2013或更高版本。

Project template showing web API option

相关讨论

我也有同样的问题，解决方法很简单

右击Solotion从"Manage Nuget Package for Sulotion"安装Microsoft.asp.net.WebAPI

就这样吧；)