it-roy-ru.com

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

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

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

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

Добавление GlobalConfiguration.Configure (WebApiConfig.Register) MVC 4

137
lko

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

Используйте Nuget , чтобы получить новейший веб-API.

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

Тогда вам все еще нужно настроить маршрутизацию веб-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, он будет иметь 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 работает:

В папку контроллеров -> Добавить новый элемент -> Класс контроллера 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-адрес, он вызовет действие GET () в новом контроллере Web API, он автоматически сопоставляется с методами/действиями в зависимости от REST, например, PUT/POST/GET/DELETE. Вы не нужно вызывать их по действию, как в MVC) URL-адрес напрямую:

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

В качестве альтернативы используйте jQuery для запроса контроллера. Запустите проект, откройте консоль (F12 в IE) и попробуйте выполнить запрос Ajax. (Проверьте свое ПОРТ И КОНТРОЛЛЕР ИМЯ)

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

Примечание: есть некоторые плюсы и минусы, которые следует учитывать при объединении MVC и Web API в проекте

Проверка справки WebAPI: http://localhost:PORT/help

241
lko