ChatGPT解决这个技术问题 Extra ChatGPT

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

假设您在创建新的 MVC (5) 项目时忘记勾选 Web API 复选框(将其添加到项目中),您需要做什么来添加 Web API 并使其正常工作?

有很多迁移问题,但似乎没有一个具有将 Web API 添加到 MVC 5 项目的完整且最新的步骤,而且它似乎与一些旧答案有所不同。

Add Web API to MVC 4

Adding GlobalConfiguration.Configure(WebApiConfig.Register) MVC 4


C
Community

更新 MVC 项目

使用 Nuget 获取最新的 Web API。

项目 - 右键单击 - 管理 Nuget 包 - 搜索 Web API(Microsoft ASP.NET Web API ...)并将其安装到您的 MVC 项目中。

然后你仍然需要让 Web API 路由 工作。来自Microsoft's Configuring 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,添加新路由。 Order of the Global.asax.cs routes is critical. 请注意,有些过时的示例使用 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 帮助

要获得 (very) helpful WebAPI help pages,请安装 WebAPI.HelpPage。请参阅 http://channel9.msdn.com/Events/Build/2014/3-644(约 42 分钟)了解它的作用。看起来很有帮助!

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

要验证 WebAPI 是否正常工作:

到控制器文件夹 -> 添加新项目 -> Web 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/Chrome 中进行测试,或者在 JavaScript 控制台中进行非获取测试。

(仅使用 URL 中的控制器,它将调用新 Web API 控制器中的 GET() 操作,它会根据 REST 自动映射到方法/操作,例如 PUT/POST/GET/DELETE。您不需要调用他们通过像在 MVC 中的操作)直接的 URL:

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);
});

Side note: There are some pros/cons to consider when combining MVC and Web API in a project

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


@Iko 我已经完成了您在代码上编写的所有内容,但是当我运行它时出现错误。它给了我一个错误
尝试搜索错误消息。这些步骤基本上是一般情况下所需的。
“Global.asax.cs 路由的顺序很关键”+1
我正在使用“旧方式”调用 WebApiConfig.Register(GlobalConfiguration.configuration);我再也无法调试了。我会开始调试,但它永远不会达到我的控制器功能。我改为“新方式” GlobalConfiguration.Configure(WebApiConfig.Register);问题得到解决。
@jason,如果你想在 URL 中使用动作名称,只需在默认路由之后复制粘贴路由,给它一个名称并像这样修改路由模板 "api/{controller}/{Action}/{id}"