Я хочу додати веб-API ASP.NET до проекту веб-додатків ASP.NET MVC 4, розробленого в Visual Studio 2012. Які кроки потрібно виконати, щоб додати функціонуючий веб-API до проекту? Я знаю, що мені потрібен контролер, що походить від ApiController, але це майже все, що я знаю.
Повідомте мене, якщо мені потрібно надати більше деталей.
Відповіді:
Кроки, які мені потрібно було виконати:
System.Web.Http.WebHost.App_Start\WebApiConfig.cs(див. Фрагмент коду нижче).System.Web.Httpу Global.asax.cs.WebApiConfig.Register(GlobalConfiguration.Configuration)в MvcApplication.Application_Start()(в файлі Global.asax.cs), перед тим реєстрації маршруту веб - зі стандартними програмами, які в іншому випадку пріоритет.System.Web.Http.ApiController.Тоді я міг би навчитися достатньо з підручника (Ваш перший веб-API ASP.NET), щоб визначити мій контролер API.
App_Start \ WebApiConfig.cs:
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:
using System.Web.Http;
...
protected void Application_Start()
{
AreaRegistration.RegisterAllAreas();
RegisterGlobalFilters(GlobalFilters.Filters);
WebApiConfig.Register(GlobalConfiguration.Configuration);
RegisterRoutes(RouteTable.Routes);
BundleConfig.RegisterBundles(BundleTable.Bundles);
}Оновлення 16.10.2015:
Word має, пакет NuGet Microsoft.AspNet.WebApi повинен бути встановлений для роботи вище.
ОНОВЛЕННЯ 22.11.2013 - це останній пакет WebApi:
Install-Package Microsoft.AspNet.WebApiОригінальна відповідь (це старіший пакет WebApi)
Install-Package AspNetWebApiБільше деталей .
Install-Package Microsoft.AspNet.WebApiзараз. Дивіться nuget.org/packages/Microsoft.AspNet.WebApi
Щоб додати WebAPI до свого проекту MVC 5
Відкрийте консоль менеджера NuGet Package та запустіть
PM> Install-Package Microsoft.AspNet.WebApiДодайте посилання на System.Web.Routing, System.Web.Netі System.Net.Httpdlls, якщо вони вже не існують
Клацніть папку контролерів правою кнопкою миші> додайте новий елемент> веб> Додати контролер Web API
Web.config буде змінено відповідно VS
Додайте Application_Startметод, якщо його вже немає
protected void Application_Start()
{
//this should be line #1 in this method
GlobalConfiguration.Configure(WebApiConfig.Register);
}Додайте наступний клас (я додав у файл global.asax.cs)
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 }
);
}
}Змініть відповідний метод веб-api
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
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title></title>
<script src="../<path_to_jquery>/jquery-1.9.1.min.js"></script>
<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);
}
});
});
</script>
</head>
<body>
....
</body>
</html>Як тільки ви додасте "контролер WebApi" в папку контролерів, Visual Studio автоматично піклується про залежності;
Visual Studio додав повний набір залежностей для ASP.NET Web API 2 до проекту "MyTestProject".
Файл Global.asax.cs у проекті може потребувати додаткових змін для включення веб-API ASP.NET.
Додайте такі посилання на область імен:
за допомогою System.Web.Http; за допомогою System.Web.Routing;
Якщо код вже не визначає метод Application_Start, додайте наступний метод:
захищена недійсність Application_Start () {}
Додайте наступні рядки до початку методу Application_Start:
GlobalConfiguration.Configure (WebApiConfig.Register);
Install-Package Microsoft.AspNet.WebApi2. Додати новий елемент "Клас контролера Web API (v2.1)". Результат: додає контролер api, але не змінюється Application_Start. З Овіном.
Ви можете встановити з nuget як зображення нижче:
Або запустіть командний рядок нижче на консолі диспетчера пакунків:
Install-Package Microsoft.AspNet.WebApiПерш ніж розпочати об’єднання проектів MVC та Web API, я б запропонував прочитати про мінуси та плюси, щоб розділити їх як різні проекти. Одна дуже важлива річ (моя власна) - це системи аутентифікації, які абсолютно різні.
Якщо вам потрібно використовувати автентифіковані запити як на MVC, так і на веб-API, вам потрібно пам’ятати, що Web API є RESTful (не потрібно тримати сеанс, прості запити HTTP тощо), але MVC це не так.
Щоб побачити відмінності в реалізації, просто створіть у Visual Studio 2013 із шаблонів два різні проекти: один для MVC та один для веб-API (не забудьте увімкнути "Індивідуальну автентифікацію" під час створення). Ви побачите велику різницю в AuthencationControllers.
Отже, будьте в курсі.
ПРИМІТКА: це лише скорочення цієї відповіді вище
Відкрийте консоль менеджера NuGet Package та запустіть
PM> Install-Package Microsoft.AspNet.WebApiДодайте посилання на System.Web.Routing, System.Web.Netі System.Net.Httpdlls, якщо вони вже не існують
Додайте наступний клас
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 }
);
}
}Додати Application_Startметод, якщо його вже немає (у файлі global.asax.cs)
protected void Application_Start()
{
//this should be line #1 in this method
GlobalConfiguration.Configure(WebApiConfig.Register);
}Клацніть папку контролерів правою кнопкою миші> додайте новий елемент> веб> Додати контролер Web API
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 або вище.
У мене була така ж проблема, рішення було таким простим
Клацніть правою кнопкою миші на сольовій установці Microsoft.ASP.NET.WebApi з "Управління Nuget Package for Sulotion"
бум, це все;)
System.Net.Http, але крім цього, це спрацювало як шарм!