Ich möchte einem in Visual Studio 2012 entwickelten ASP.NET MVC 4-Webanwendungsprojekt eine ASP.NET-Web-API hinzufügen . Welche Schritte muss ich ausführen, um dem Projekt eine funktionierende Web-API hinzuzufügen? Ich bin mir bewusst, dass ich einen Controller brauche, der von ApiController abgeleitet ist, aber das ist ungefähr alles, was ich weiß.
Lassen Sie mich wissen, wenn ich weitere Details angeben muss.
Antworten:
Die Schritte, die ich ausführen musste, waren:
System.Web.Http.WebHost.App_Start\WebApiConfig.cs(siehe Codefragment unten).System.Web.Httpin importieren Global.asax.cs.WebApiConfig.Register(GlobalConfiguration.Configuration)in MvcApplication.Application_Start()(in Datei Global.asax.cs), bevor die Standard Web Application Route wie die Registrierung sonst Vorrang haben würde.System.Web.Http.ApiController.Ich könnte dann aus dem Lernprogramm (Ihre erste ASP.NET-Web-API) genug lernen , um meinen API-Controller zu definieren.
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);
}Update 10.16.2015:
Word hat es, das NuGet-Paket Microsoft.AspNet.WebApi muss installiert sein, damit das oben genannte funktioniert.
UPDATE 22.11.2013 - Dies ist das neueste WebApi-Paket:
Install-Package Microsoft.AspNet.WebApiUrsprüngliche Antwort (dies ist ein älteres WebApi-Paket)
Install-Package AspNetWebApiWeitere Details .
Install-Package Microsoft.AspNet.WebApijetzt. Siehe nuget.org/packages/Microsoft.AspNet.WebApi
So fügen Sie WebAPI in mein MVC 5-Projekt ein
Öffnen Sie die NuGet Package Manager-Konsole und führen Sie sie aus
PM> Install-Package Microsoft.AspNet.WebApiFügen Sie Verweise auf System.Web.Routing, System.Web.Netund System.Net.HttpDLLs , wenn es nicht schon
Klicken Sie mit der rechten Maustaste auf den Ordner "Controller"> Neues Element hinzufügen> Web> Web-API-Controller hinzufügen
Web.config wird von VS entsprechend geändert
Application_StartMethode hinzufügen , falls noch nicht vorhanden
protected void Application_Start()
{
//this should be line #1 in this method
GlobalConfiguration.Configure(WebApiConfig.Register);
}Fügen Sie die folgende Klasse hinzu (ich habe in der Datei global.asax.cs hinzugefügt)
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 }
);
}
}Ändern Sie die Web-API-Methode entsprechend
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();
}
}
}Neu erstellen und testen
Erstellen Sie eine einfache HTML-Seite
<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>Sobald Sie einen "WebApi Controller" im Ordner "Controller" hinzufügen, kümmert sich Visual Studio automatisch um Abhängigkeiten.
Visual Studio hat den vollständigen Satz von Abhängigkeiten für ASP.NET Web API 2 zum Projekt 'MyTestProject' hinzugefügt.
Für die Datei Global.asax.cs im Projekt sind möglicherweise zusätzliche Änderungen erforderlich, um die ASP.NET-Web-API zu aktivieren.
Fügen Sie die folgenden Namespace-Referenzen hinzu:
using System.Web.Http; using System.Web.Routing;
Wenn der Code noch keine Application_Start-Methode definiert, fügen Sie die folgende Methode hinzu:
protected void Application_Start () {}
Fügen Sie am Anfang der Application_Start-Methode die folgenden Zeilen hinzu:
GlobalConfiguration.Configure (WebApiConfig.Register);
Install-Package Microsoft.AspNet.WebApi2. Fügen Sie das neue Element "Web API Controller Class (v2.1)" hinzu. Ergebnis: Fügt den API-Controller hinzu, ändert sich aber nicht Application_Start. Mit Owin.
Sie können von Nuget aus wie folgt installieren:
Oder führen Sie die folgende Befehlszeile in der Package Manager-Konsole aus:
Install-Package Microsoft.AspNet.WebApiBevor Sie mit dem Zusammenführen von MVC- und Web-API-Projekten beginnen, sollten Sie sich über Vor- und Nachteile informieren , um diese als unterschiedliche Projekte zu trennen. Eine sehr wichtige Sache (meine eigene) sind Authentifizierungssysteme, die völlig anders sind.
Wenn Sie authentifizierte Anforderungen sowohl für MVC als auch für die Web-API verwenden müssen, müssen Sie sich daran erinnern, dass die Web-API REST-fähig ist (Sitzung, einfache HTTP-Anforderungen usw. müssen nicht beibehalten werden), MVC jedoch nicht.
Um die Unterschiede bei den Implementierungen zu untersuchen, erstellen Sie einfach zwei verschiedene Projekte in Visual Studio 2013 aus Vorlagen: eines für MVC und eines für die Web-API (vergessen Sie nicht, während der Erstellung die Option "Individuelle Authentifizierung" zu aktivieren). Sie werden einen großen Unterschied bei AuthencationControllern feststellen.
Also sei dir bewusst.
HINWEIS: Dies ist nur eine Abkürzung dieser Antwort oben
Öffnen Sie die NuGet Package Manager-Konsole und führen Sie sie aus
PM> Install-Package Microsoft.AspNet.WebApiFügen Sie Verweise auf System.Web.Routing, System.Web.Netund System.Net.HttpDLLs , wenn es nicht schon
Fügen Sie die folgende Klasse hinzu
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 }
);
}
}In Application_StartMethode , wenn nicht bereits (in global.asax.cs - Datei)
protected void Application_Start()
{
//this should be line #1 in this method
GlobalConfiguration.Configure(WebApiConfig.Register);
}Klicken Sie mit der rechten Maustaste auf den Ordner "Controller"> Neues Element hinzufügen> Web> Web-API-Controller hinzufügen
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";
}
}
}Die obige Lösung funktioniert perfekt. Ich bevorzuge die Web-API-Option, während ich die Projektvorlage auswähle (siehe Abbildung unten)
Hinweis: Die Lösung funktioniert mit Visual Studio 2013 oder höher. Die ursprüngliche Frage wurde 2012 gestellt und ist 2016, daher wird eine Lösung für Visual Studio 2013 oder höher hinzugefügt.
Ich hatte das gleiche Problem, die Lösung war so einfach
Klicken Sie mit der rechten Maustaste auf solotion. Installieren Sie Microsoft.ASP.NET.WebApi unter "Nuget-Paket für Sulotion verwalten".
Boom das war's;)
System.Net.Http, aber ansonsten funktionierte es wie ein Zauber!