Comment ajouter une API Web à un projet d'application Web ASP.NET MVC 4 existant ?

Question

Je souhaite ajouter un API Web ASP.NET à un projet d'application Web ASP.NET MVC 4, développé dans Visual Studio 2012. Quelles étapes dois-je suivre pour ajouter une API Web fonctionnelle au projet ? Je sais que j'ai besoin d'un contrôleur dérivant de ApiController, mais c'est à peu près tout ce que je sais.

Faites-moi savoir si je dois fournir plus de détails.

Answer 1

Les étapes que je devais effectuer étaient :

1. Ajouter une référence à System.Web.Http.WebHost .
2. Ajouter App_Start\WebApiConfig.cs (voir l'extrait de code ci-dessous).
3. Importer l'espace de noms System.Web.Http en Global.asax.cs .
4. Appelez WebApiConfig.Register(GlobalConfiguration.Configuration) en MvcApplication.Application_Start() (en fichier Global.asax.cs ), avant d'enregistrer la route par défaut de l'application Web, qui aurait autrement la priorité.
5. Ajouter un contrôleur dérivant de System.Web.Http.ApiController .

Je pourrais alors apprendre suffisamment de le tutoriel (Your First ASP.NET Web API) 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 :

Le paquet NuGet Microsoft.AspNet.WebApi doit être installé pour que le programme ci-dessus fonctionne.

Answer 2

UPDATE 11/22/2013 - il s'agit du dernier paquet WebApi :

Install-Package Microsoft.AspNet.WebApi

Réponse originale (il s'agit d'un ancien paquet WebApi)

Install-Package AspNetWebApi

Plus de détails .

Answer 3

Dès que vous ajoutez un "WebApi Controller" dans le dossier controllers, Visual Studio s'occupe automatiquement des dépendances ;

Visual Studio a ajouté l'ensemble complet de dépendances pour ASP.NET Web API 2 au projet 'MyTestProject'.

Le fichier Global.asax.cs du projet peut nécessiter des modifications supplémentaires pour activer l'API Web ASP.NET.

1. Ajoutez les références d'espace de nom suivantes :

   en utilisant System.Web.Http ; en utilisant System.Web.Routing ;

2. Si le code ne définit pas déjà une méthode Application_Start, ajoutez la méthode suivante :

   protected void Application_Start() { }

3. Ajoutez les lignes suivantes au début de la méthode Application_Start :

   GlobalConfiguration.Configure(WebApiConfig.Register) ;

Answer 4

Vous pouvez installer à partir de nuget comme l'image ci-dessous :

Ou, exécutez la ligne de commande ci-dessous dans la console du gestionnaire de paquets :

Install-Package Microsoft.AspNet.WebApi

Answer 5

Avant de commencer à fusionner des projets MVC et API Web, je vous suggère de lire le document suivant pour et contre de les séparer en tant que projets différents. Une chose très importante (la mienne) concerne les systèmes d'authentification, qui sont totalement différents.

Si vous avez besoin d'utiliser des requêtes authentifiées à la fois sur MVC et sur l'API Web, vous devez vous rappeler que l'API Web est RESTful (il n'est pas nécessaire de conserver la session, requêtes HTTP simples, etc.

Pour examiner les différences d'implémentation, il suffit de créer deux projets différents dans Visual Studio 2013 à partir de modèles : un pour MVC et un pour Web API (n'oubliez pas d'activer l'authentification individuelle pendant la création). Vous verrez beaucoup de différences dans les AuthencationControllers.

Alors, faites attention.