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

Ответ 1

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

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

Проект - щелкните правой кнопкой мыши - Управление пакетами Nuget - найдите веб-API (веб-интерфейс Microsoft ASP.NET...) и установите его в проект 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

Чтобы получить (very) полезные справочные страницы WebAPI, установите WebAPI.HelpPage. См. http://channel9.msdn.com/Events/Build/2014/3-644 (~ 42 минуты) для того, что он делает. Это выглядит очень полезно!

Консоль Nuget: Install-Package Microsoft.AspNet.WebApi.HelpPage

Чтобы проверить работу WebAPI:

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

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

Альтернативно используйте jQuery для запроса контроллера. Запустите проект, откройте консоль (F12 в IE) и попробуйте выполнить запрос Ajax. (Проверьте свой PORT и CONTROLLERNAME)

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

Боковое примечание. При объединении MVC и веб-API в проекте есть несколько плюсов и минусов

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