Chcę dodać interfejs API sieci Web ASP.NET do projektu aplikacji sieci Web ASP.NET MVC 4, opracowanego w Visual Studio 2012. Jakie kroki należy wykonać, aby dodać działający interfejs API sieci Web do projektu? Wiem, że potrzebuję kontrolera pochodzącego z ApiController, ale to wszystko, co wiem.
Daj mi znać, jeśli będę musiał podać więcej szczegółów.
Odpowiedzi:
Kroki, które musiałem wykonać to:
System.Web.Http.WebHost.App_Start\WebApiConfig.cs(patrz fragment kodu poniżej).System.Web.Httpdo Global.asax.cs.WebApiConfig.Register(GlobalConfiguration.Configuration)na MvcApplication.Application_Start()(w pliku Global.asax.cs), zanim rejestracji trasy domyślnej aplikacji sieci Web jako że w przeciwnym razie ma pierwszeństwo.System.Web.Http.ApiController.Mógłbym wtedy nauczyć się wystarczająco dużo z samouczka (Twój pierwszy interfejs API sieci Web ASP.NET), aby zdefiniować kontroler 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);
}Aktualizacja 10.16.2015:
Word ma to, pakiet NuGet Microsoft.AspNet.WebApi musi być zainstalowany, aby powyższe działało.
AKTUALIZACJA 22.11.2013 - to najnowszy pakiet WebApi:
Install-Package Microsoft.AspNet.WebApiOryginalna odpowiedź (jest to starszy pakiet WebApi)
Install-Package AspNetWebApiWięcej szczegółów .
Install-Package Microsoft.AspNet.WebApijuż teraz chcesz . Zobacz nuget.org/packages/Microsoft.AspNet.WebApi
Aby dodać WebAPI do mojego projektu MVC 5.
Otwórz konsolę menedżera pakietów NuGet i uruchom
PM> Install-Package Microsoft.AspNet.WebApiDodaj odniesień do System.Web.Routing, System.Web.Neti System.Net.Httpbibliotek DLL, jeśli nie ma już
Kliknij folder kontrolerów prawym przyciskiem myszy> dodaj nowy element> sieć> Dodaj kontroler API sieci Web
Web.config zostanie odpowiednio zmodyfikowany przez VS
Dodaj Application_Startmetodę, jeśli jeszcze jej nie ma
protected void Application_Start()
{
//this should be line #1 in this method
GlobalConfiguration.Configure(WebApiConfig.Register);
}Dodaj następującą klasę (dodałem w pliku 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 }
);
}
}Zmodyfikuj odpowiednio metodę interfejsu API sieci Web
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();
}
}
}Przebuduj i przetestuj
Zbuduj prostą stronę 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>Jak tylko dodasz „kontroler WebApi” w folderze kontrolerów, Visual Studio automatycznie zajmie się zależnościami;
Program Visual Studio dodał pełny zestaw zależności dla ASP.NET Web API 2 do projektu „MyTestProject”.
Plik Global.asax.cs w projekcie może wymagać dodatkowych zmian, aby włączyć interfejs API sieci Web ASP.NET.
Dodaj następujące odwołania do przestrzeni nazw:
using System.Web.Http; using System.Web.Routing;
Jeśli kod nie definiuje jeszcze metody Application_Start, dodaj następującą metodę:
protected void Application_Start () {}
Dodaj następujące wiersze na początku metody Application_Start:
GlobalConfiguration.Configure (WebApiConfig.Register);
Install-Package Microsoft.AspNet.WebApi2. Dodaj nowy element „Klasa kontrolera API sieci Web (v2.1)”. Wynik: dodaje kontroler interfejsu API, ale się nie zmienia Application_Start. Z Owinem.
Możesz zainstalować z nuget jak na poniższym obrazku:
Lub uruchom poniższy wiersz poleceń w konsoli Menedżera pakietów:
Install-Package Microsoft.AspNet.WebApiZanim zaczniesz łączyć projekty MVC i Web API, proponuję przeczytać o wadach i zaletach, aby rozdzielić je jako różne projekty. Jedną bardzo ważną rzeczą (moją) są systemy uwierzytelniania, które są zupełnie inne.
JEŚLI musisz używać uwierzytelnionych żądań zarówno w interfejsie MVC, jak i interfejsie API sieci Web, musisz pamiętać, że interfejs API sieci Web jest w stanie RESTful (nie trzeba utrzymywać sesji, prostych żądań HTTP itp.), Ale MVC nie.
Aby zobaczyć różnice w implementacjach, po prostu stwórz 2 różne projekty w Visual Studio 2013 z szablonów: jeden dla MVC i jeden dla Web API (nie zapomnij włączyć „Indywidualnego uwierzytelnienia” podczas tworzenia). Zobaczysz dużą różnicę w AuthencationControllers.
Bądź więc świadomy.
UWAGA: jest to po prostu skrót od tej odpowiedzi powyżej
Otwórz konsolę menedżera pakietów NuGet i uruchom
PM> Install-Package Microsoft.AspNet.WebApiDodaj odniesień do System.Web.Routing, System.Web.Neti System.Net.Httpbibliotek DLL, jeśli nie ma już
Dodaj następującą klasę
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 }
);
}
}Dodaj Application_Startmetodę, jeśli jeszcze jej nie ma (w pliku global.asax.cs)
protected void Application_Start()
{
//this should be line #1 in this method
GlobalConfiguration.Configure(WebApiConfig.Register);
}Kliknij folder kontrolerów prawym przyciskiem myszy> dodaj nowy element> sieć> Dodaj kontroler API sieci Web
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";
}
}
}Powyższe rozwiązanie działa idealnie. Wolę wybrać opcję Web API podczas wybierania szablonu projektu, jak pokazano na poniższym obrazku
Uwaga: Rozwiązanie działa z Visual Studio 2013 lub nowszym. Pierwotne pytanie zostało zadane w 2012 roku i jest to rok 2016, dlatego dodano rozwiązanie Visual Studio 2013 lub nowszy.
Miałem ten sam problem, rozwiązanie było takie proste
Kliknij prawym przyciskiem myszy Solotion, zainstaluj Microsoft.ASP.NET.WebApi z „Manage Nuget Package for Sulotion”
boom to wszystko;)
System.Net.Http, ale poza tym działało to jak urok!