Je souhaite ajouter une API Web ASP.NET à un projet d'application Web ASP.NET MVC 4, développé dans Visual Studio 2012. Quelles étapes dois-je effectuer pour ajouter une API Web fonctionnelle au projet? Je suis conscient que j'ai besoin d'un contrôleur dérivé d'ApiController, mais c'est à peu près tout ce que je sais.
Faites-moi savoir si j'ai besoin de fournir plus de détails.
Réponses:
Les étapes que je devais effectuer étaient:
System.Web.Http.WebHost.App_Start\WebApiConfig.cs(voir l'extrait de code ci-dessous).System.Web.Httpde noms dans Global.asax.cs.WebApiConfig.Register(GlobalConfiguration.Configuration)à MvcApplication.Application_Start()(dans le fichier Global.asax.cs), avant l' enregistrement de la voie d'application Web par défaut comme qui autrement prioritaire.System.Web.Http.ApiController.Je pourrais ensuite en apprendre suffisamment du tutoriel (Votre première API Web ASP.NET) pour définir mon contrôleur d'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);
}
Mise à jour 10.16.2015:
Word l'a, le package NuGet Microsoft.AspNet.WebApi doit être installé pour que ce qui précède fonctionne.
MISE À JOUR 11/22/2013 - c'est le dernier package WebApi:
Install-Package Microsoft.AspNet.WebApiRéponse originale (il s'agit d'un ancien package WebApi)
Install-Package AspNetWebApiPlus de détails .
Install-Package Microsoft.AspNet.WebApimaintenant. Voir nuget.org/packages/Microsoft.AspNet.WebApi
Pour ajouter WebAPI dans mon projet MVC 5.
Ouvrez la console du gestionnaire de packages NuGet et exécutez
PM> Install-Package Microsoft.AspNet.WebApiAjouter des références à System.Web.Routing, System.Web.Netet System.Net.Httpdll sinon déjà là
Cliquez avec le bouton droit sur le dossier des contrôleurs> ajouter un nouvel élément> Web> Ajouter un contrôleur d'API Web
Web.config sera modifié en conséquence par VS
Ajouter une Application_Startméthode si ce n'est déjà fait
protected void Application_Start()
{
//this should be line #1 in this method
GlobalConfiguration.Configure(WebApiConfig.Register);
}
Ajoutez la classe suivante (j'ai ajouté dans le fichier 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 }
);
}
}
Modifiez la méthode de l'API Web en conséquence
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();
}
}
}
Reconstruire et tester
Créez une page HTML simple
<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>
Dès que vous ajoutez un "WebApi Controller" sous le dossier controllers, Visual Studio s'occupe automatiquement des dépendances;
Visual Studio a ajouté l'ensemble complet des dépendances pour l'API Web ASP.NET 2 pour projeter «MyTestProject».
Le fichier Global.asax.cs du projet peut nécessiter des modifications supplémentaires pour activer l'API Web ASP.NET.
Ajoutez les références d'espace de noms suivantes:
using System.Web.Http; using System.Web.Routing;
Si le code ne définit pas déjà une méthode Application_Start, ajoutez la méthode suivante:
void protégé Application_Start () {}
Ajoutez les lignes suivantes au début de la méthode Application_Start:
GlobalConfiguration.Configure (WebApiConfig.Register);
Install-Package Microsoft.AspNet.WebApi2. Ajoutez un nouvel élément "Classe de contrôleur API Web (v2.1)". Résultat: ajoute le contrôleur api mais ne change pas Application_Start. Avec Owin.
Vous pouvez installer à partir de nuget comme l'image ci-dessous:
Ou, exécutez la ligne de commande ci-dessous sur la console du gestionnaire de packages:
Install-Package Microsoft.AspNet.WebApiAvant de commencer à fusionner des projets MVC et API Web, je suggère de lire les inconvénients et les avantages pour les séparer en tant que projets différents. Une chose très importante (la mienne) est les systèmes d'authentification, qui sont totalement différents.
SI vous devez utiliser des requêtes authentifiées sur MVC et API Web, vous devez vous rappeler que l'API Web est RESTful (pas besoin de garder la session, les requêtes HTTP simples, etc.), mais MVC ne l'est pas.
Pour regarder les différences d'implémentations, créez simplement 2 projets différents dans Visual Studio 2013 à partir de modèles: un pour MVC et un pour API Web (n'oubliez pas d'activer "Authentification individuelle" lors de la création). Vous verrez beaucoup de différence dans AuthencationControllers.
Alors, soyez conscient.
REMARQUE: ce n'est qu'une abréviation de cette réponse ci-dessus
Ouvrez la console du gestionnaire de packages NuGet et exécutez
PM> Install-Package Microsoft.AspNet.WebApiAjouter des références à System.Web.Routing, System.Web.Netet System.Net.Httpdll sinon déjà là
Ajoutez la classe suivante
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 }
);
}
}
Ajouter une Application_Startméthode si elle n'y est pas déjà (dans le fichier global.asax.cs)
protected void Application_Start()
{
//this should be line #1 in this method
GlobalConfiguration.Configure(WebApiConfig.Register);
}
Cliquez avec le bouton droit sur le dossier des contrôleurs> ajouter un nouvel élément> Web> Ajouter un contrôleur d'API 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";
}
}
}
La solution ci-dessus fonctionne parfaitement. Je préfère choisir l'option API Web tout en sélectionnant le modèle de projet comme indiqué dans l'image ci-dessous
Remarque: La solution fonctionne avec Visual Studio 2013 ou supérieur. La question d'origine a été posée en 2012 et c'est 2016, donc ajout d'une solution Visual Studio 2013 ou supérieure.
J'ai eu le même problème, la solution était si simple
Faites un clic droit sur l'installation de solotion Microsoft.ASP.NET.WebApi à partir de "Gérer le package Nuget pour Sulotion"
boom c'est tout;)
System.Net.Http, mais à part cela, cela a fonctionné comme un charme!