Как добавить Web API к существующему ASP.NET проект веб-приложения MVC (5)?

предполагая, что вы забыли отметить флажок веб-API (добавить его в проект) при создании нового проекта MVC (5), что вам нужно сделать, чтобы добавить веб-API и заставить его работать?

есть куча вопросов миграции, но ни у одного из них не было полных и современных шагов для добавления веб-API в проект MVC 5, и, похоже, он изменился с некоторых старых ответов.

добавить веб-API в MVC 4

добавить GlobalConfiguration.Настроить(WebApiConfig.Регистрация) MVC 4

130
asp.net asp.net-mvc asp.net-mvc-5 asp.net-web-api c#

1 ответов

обновить проект MVC

использовать NuGet для чтобы получить новейший веб-API.

проект-щелкните правой кнопкой мыши-Управление пакетами Nuget-поиск веб-API (Microsoft ASP.NET Web API ...) и установите его в свой проект MVC.

тогда вам все равно нужно получить маршрутизация Web API на работу. От настройка Microsoft 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, он будет иметь глобальные.асакс.cs добавить новые маршруты. порядок мировой.асакс.маршруты cs имеют решающее значение. Примечание есть устаревшие примеры, которые используют WebApiConfig.Register

добавьте эту строку в Global.асакс.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, установить Веб-API.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 для тестирования без get.

(только с контроллером URL-адрес, который он вызовет действие GET () в новом контроллере веб-API, автоматически сопоставляется с методами/действиями в зависимости от остальных, например PUT/POST/GET/DELETE. Вам не нужно вызывать их действием, как в MVC) URL-адрес напрямую:

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

как вариант используйте jQuery для запроса контроллера. Запустите проект, Откройте консоль (F12 в IE) и попробуйте выполнить запрос Ajax. (Проверьте свой порт и 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

228