Comment ajouter des API Web existant ASP.NET MVC 4 projet d'Application Web?

Je souhaite ajouter un ASP.NET Web API à un ASP.NET MVC 4 projet d'Application Web développée en Visual Studio 2012. Quelles démarches dois-je effectuer pour ajouter un fonctionnement de l'API Web pour le projet? Je suis conscient que j'ai besoin d'un contrôleur découlant de ApiController, mais c'est tout ce que je sais.

Permettez-moi de savoir si j'ai besoin de fournir plus de détails.

InformationsquelleAutor aknuds1 | 2012-08-16

442

Les étapes que j'ai besoin sont:
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 dans Global.asax.cs.
4. Appel WebApiConfig.Register(GlobalConfiguration.Configuration) dans MvcApplication.Application_Start() (dans le fichier Global.asax.cs), avant l'enregistrement de l'Application Web par défaut en tant qu'itinéraire qui, autrement, seraient la priorité.
5. Ajouter un contrôleur découlant de System.Web.Http.ApiController.
Je puisse apprendre assez de le tutoriel (Votre Premier ASP.NET Web API) pour définir mon API contrôleur.

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 });
    }
}
```
Mondiale.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:

Mot, le package NuGet Microsoft.AspNet.WebApi doit être installé pour que le ci-dessus pour travailler.
- Cela a été vraiment utile. J'ai dû ajouter une référence à System.Net.Http ainsi, mais en dehors de cela, il a travaillé comme un charme!
- Cool, je viens de tester en créant un nouveau MVC 4 projet Internet, cependant, et il a déjà des références System.Net.Http. Alors peut-être votre cas est un peu différente?
- Ouais, le mien était un MVC 3 application que j'avais mis à jour manuellement pour MVC 4. Ne sais pas si cela pourrait être la raison.
- Que serait ma conjecture.
- J'ai mis à jour un projet de MVC3 à 4 ainsi et également nécessaire d'ajouter une référence à System.Web.Http.
- J'ai créé une "Application Internet" et il semble que tout cela est fait pour vous sortir de la boîte.
- Quelqu'un sait si cela va vous permettre de créer l'équivalent d'une nouvelle zone dans le projet appelé "api" qui a ses propres contrôleurs et tel caché sous un répertoire de l'api? Ensuite, vous pourriez avoir votre web standard pour les contrôleurs de site web dans la région habituelle et un ensemble tout à fait différent en vertu de l'api. Wow, j'espère vraiment que cela avait un sens.
- L'API Web itinéraire de cette réponse signifie que les demandes d' /api/* acheminés aux contrôleurs d'API. Je ne pense pas que cela importe si vous mettez votre API contrôleurs dans un sous-répertoire ("api"), bien que je l'ai fait dans mes projets. Juste essayer pour vous-même.
- Vous pouvez utiliser nuget maintenant, et rester au top de tous les changements! nuget.org/packages/Microsoft.AspNet.WebApi
- Bien qu'il n'est pas nécessaire d'être dans une Zone "api" il joue plus agréable avec le Html helpers - un peu comme ça. Les assistants eux-mêmes sont dans le besoin d'un peu d'aide quand il s'agit de zones à mon humble avis.
- de plus, cette méthode semble fonctionner pour mvc 5
- c'est un grand article, mais je suis sûrement fait quelque chose de mal. Je suis en train de le faire fonctionner sur MVC 5, sans succès. Je l'ai fait selon cette explication, puis je clic droit sur "Contrôleurs" et ajout de la rubrique "Web API 2 Contrôleur avec des actions, à l'aide de Entity Framework" où j'ai choisi ma classe de modèle de base de données et le contexte. Tout s'est bien passé mais quand j'ai essayé d'accès /api/(MyController)... BOOM: 404
- Désolé, je n'ai pas essayé MVC 5, peut-être que la gamme a changé? Êtes-vous sûr que vous avez accès au contrôleur avec le droit de l'URL? I. e., si c'est nommée MyController, vous devriez pouvoir y accéder comme /api/Ma.
- C'est exactement ce que j'ai fait... ça doit être quelque chose d'autre... pensez vous que cela peut être lié à ma configuration SSL=TRUE (HTTPS)? Merci
- Je n'ai aucune idée vraiment. Mon conseil serait de créer un nouveau site Web API 2 du projet, et de voir comment cela fonctionne.
- Merci, pas de prob!
- Assurez-vous de noter le "avant d'enregistrer l'Application Web par défaut itinéraire que qui serait autrement prioritaire" commentaire ou vous obtiendrez un HTTP 404 "ressource non trouvée erreur, même si vous pourriez avoir tout le reste en fait câblé correctement.
- Je ne voudrais pas obtenir que cela fonctionne jusqu'à ce que j'ai changé mon api web inscrire à: GlobalConfiguration.Configurer(WebApiConfig.Registre);
- Pourquoi "api/{controller}/{id}" pas "api/{controller}/{action}/{id}"?
- Je me souviens, avec l'API Web contrôleurs représentent (de REPOS) des ressources, par exemple les utilisateurs, et les actions ne rentre pas dans ce schéma. Par exemple, vous pouvez émettre une requête GET pour /api/users/1, ce qui signifie que pour obtenir de l'utilisateur 1.
- Peut-être WebApiConfig.Register(GlobalConfiguration.Configuration); doit être après AreaRegistration.RegisterAllAreas();.
- Je suppose que c'est trop tard mais quelqu'un d'autre le fera probablement le résoudre plus vite si c'est ce que j'avais. GlobalConfiguration.Configurer(WebApiConfig.Registre); Mondiale.asax va de l'avant RouteConfig.RegisterRoutes(RouteTable.Itinéraires);
- Bonjour Maxime, oui, je sais, vous avez probablement fixé après vérification de ma propre réponse 🙂 stackoverflow.com/questions/22401403/...
- J'ai dû courir à la suite de "Install-Package Microsoft.AspNet.WebApi" en outre les étapes ci-dessus pour obtenir que cela fonctionne. Merci
- Quoi que ce soit sur autorisation?
- J'ai aussi besoin de GlobalConfiguration.La Configuration.EnsureInitialized(); à la fin de mes asax
- Hébergeur contient GlobalConfiguration stackoverflow.com/a/21402541/1175496
- En suivant les étapes ci-dessus a fonctionne très bien, sauf pour une question. La réponse à la question que j'ai eu, c'est sur: assurez-vous que HttpConfiguration.EnsureInitialized()
- Grâce a été vraiment utile.
- fonctionne comme un charme .... belle explication
- Je n'ai pas trouver de Système.Web.Http.Hébergeur dans ma fenêtre Ajouter une Référence. J'ai eu à utiliser PMC avec la commande suivante: Install-Package Microsoft.AspNet.WebApi.WebHost. Merci pour ce partage @aknuds1.
InformationsquelleAutor aknuds1
76

Mise à JOUR 11/22/2013 - c'est la dernière WebApi package:
```
Install-Package Microsoft.AspNet.WebApi
```
Réponse originale à cette question (c'est une ancienne WebApi package)
```
Install-Package AspNetWebApi
```
Plus détails.
- En 2013, c'est un héritage colis et vous souhaitez Install-Package Microsoft.AspNet.WebApi maintenant. Voir nuget.org/packages/Microsoft.AspNet.WebApi
InformationsquelleAutor cdeutsch

Pour ajouter WebAPI dans mon MVC 5 projet.

Ouvrir le gestionnaire de Package NuGet console et lancez
```
PM> Install-Package Microsoft.AspNet.WebApi
```
Ajouter des références à System.Web.Routing, System.Web.Net et System.Net.Http dll si ce n'est déjà fait)
À droite, cliquez sur contrôleurs de dossier > ajouter un nouvel élément > web > Ajouter des Web API contrôleur
Web.la configuration sera modifié en conséquence par VS

Ajouter Application_Start méthode si ce n'est déjà fait)

protected void Application_Start()
{
    //this should be line #1 in this method
    GlobalConfiguration.Configure(WebApiConfig.Register);
}

Ajouter la classe suivante (j'ai ajouté mondiale.asax.cs fichier)

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 }
         );
     }
 }

Modifier l'api web de méthode 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();
        }
    }
}

De reconstruction et de test

Construire 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>

Le point qui a créé une différence a été de placer le WebApiconfig.S'inscrire dans la première ligne, comme cela a été mentionné par @kheya
Je voudrais ajouter, votre api contrôleur nom doit se terminer par Controller, comme CarController (et pas seulement de Voiture)!!! Donc, beaucoup de gens l'oublient et obtenir un message d'erreur "Aucun type a été trouvé qui correspond le contrôleur nommé {0}'"
Pour être plus efficace avec cette belle réponse, vous pouvez ignorer les étapes 4, 8 et 9. (ils ne sont pas si essentiel), Et si vous modifiez l'ordre de l'étape 5 et 6, ils auront plus de sens (il est préférable de créer une classe, puis l'utiliser, au lieu d'utiliser la classe puis le créer)
Voir la version abrégée de cette réponse ici stackoverflow.com/a/55002095
Où sommes-nous exactement l'ajout de références à Système.Web.De routage, System.Web.Net et le Système.Net.Http?

InformationsquelleAutor kheya

26

Dès que vous ajoutez un "WebApi Contrôleur" sous les contrôleurs de dossier, Visual Studio prend en charge automatiquement les dépendances;
Visual Studio a ajouté l'ensemble des dépendances pour ASP.NET Web
API de 2 à projet "MyTestProject'.

Le Mondial.asax.cs fichier dans le projet peut nécessiter des modifications supplémentaires
pour activer ASP.NET l'API Web.
1. Ajouter l'espace de noms suivant les références:
  
  en utilisant le Système.Web.Http;
  en utilisant le Système.Web.Routage;
2. Si le code n'est pas déjà définir une méthode Application_Start, ajoutez la méthode suivante:
  
  protected void Application_Start()
  {
  }
3. Ajouter les lignes suivantes au début de la méthode Application_Start:
  
  GlobalConfiguration.Configurer(WebApiConfig.Registre);
- C'est de loin le moyen le plus facile pour atteindre cet maintenant.
- Ne fonctionne pas ici. 1. Nuget: Install-Package Microsoft.AspNet.WebApi 2. Ajouter un nouvel élément "Web API de la Classe Controller (v2.1)". Résultat: ajoute l'api contrôleur, mais ne change pas Application_Start. Avec Owin.
- c'est la bonne réponse lorsque vous avez vs2015 - mise à jour 3 et l'ajout de l'api web 2 contrôleur.
- Il n'en 2017, mais j'ai eu à mettre à jour mon WebApi assemblées. J'ai également eu à créer le WebApiConfig classe manuellement, docs.microsoft.com/en-us/aspnet/web-api/overview/advanced/...
InformationsquelleAutor Teoman shipahi
22

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

Ou, exécutez la commande ci-dessous de la ligne sur la Console du Gestionnaire de Package:
```
Install-Package Microsoft.AspNet.WebApi
```
- Alors, quoi d'autre dois-je faire, à part ajouter le contrôleur? C'est pourquoi j'ai posté cette question en premier lieu, le tutoriel n'a pas vraiment dire, car il suppose un projet d'API Web. J'ai ajouté une API contrôleur, mais il n'est pas acheminé vers.
- Le tutoriel n'est pas d'une grande aide en ce qui concerne l'ajout d'une API Web pour un projet existant, si j'ai tout compris à partir d'une API Web du projet, comme indiqué dans ma réponse.
- Je suis d'accord, il semble que la plomberie est déjà installé si vous utilisez l'Web App modèle de projet.
- web api version 2.2 sera installer avec mvc 4 ? prend-il en charge MVC 4?
InformationsquelleAutor cuongle
19

Avant de commencer la fusion MVC et Web API projets, je vous propose de lire sur inconvénients et les avantages de séparer ces différents projets. Une chose très importante (le mien) est d'authentification des systèmes, ce qui est totalement différent.

SI vous avez besoin d'utiliser les requêtes authentifiées sur les deux MVC et Web API, vous devez vous rappeler que le Web API RESTful (n'avez pas besoin de garder de la session, de simples requêtes HTTP, etc.), mais MVC n'est pas.

De regarder sur les différences d'implémentations suffit de créer 2 différents projets dans Visual Studio 2013 à partir de Modèles: l'un pour le MVC et un pour les API Web (n'oubliez pas d'activer l'Authentification Individuelle" lors de la création). Vous verrez une grande différence dans AuthencationControllers.

Donc, être conscient.

InformationsquelleAutor Yarkov Anton
3

La solution ci-dessus fonctionne parfaitement. Je préfère choisir des API Web option tout en sélectionnant le modèle de projet comme le montre l'image ci-dessous

Remarque: La solution fonctionne avec Visual Studio 2013 ou plus. La question initiale a été posée en 2012 et 2016, donc l'ajout d'une solution de Visual Studio 2013 ou plus.
- Si vous créez un projet qui implique l'API Web, il sera plus facile de choisir le Web API. L'option va créer tous les fichiers requis comme indiqué dans les réponses ci-dessus.
- Le problème ici est dans Visual studio 2012 et mvc 4. Bien que votre solution est très bien, vous ne pouvez pas le faire de cette manière dans VS 2012
- C'est un bon point et j'ai essayé les solutions ci-dessus avec VS 2013. Merci @netfed pour les souligne.
- Salut à Tous, j'ai l'API élément de travail dans mon MVC solution, mais en tant que par défaut, il a essayé d'exécuter la solution comme une solution d'API. Mais je veux qu'il fonctionne comme un MVC solution par défaut et puis si vous allez à l'API de localisation, etc, exécutez l'Api.. quelqu'un d'autre A eu ce problème et réussi à le résoudre? Merci
InformationsquelleAutor Sankar Krishnamoorthy
3

NOTE : ceci est juste une abréviation de cette réponse ci-dessus
1. Ouvrir le gestionnaire de Package NuGet console et lancez
```
PM> Install-Package Microsoft.AspNet.WebApi
```
2. Ajouter des références à System.Web.Routing, System.Web.Net et System.Net.Http dll si ce n'est déjà fait)
3. Ajouter 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 }
         );
     }
 }
```
4. Ajouter Application_Start méthode si ce n'est déjà fait (en global.asax.cs fichier)
```
protected void Application_Start()
{
    //this should be line #1 in this method
    GlobalConfiguration.Configure(WebApiConfig.Register);
}
```
5. À droite, cliquez sur contrôleurs de dossier > ajouter un nouvel élément > web > Ajouter des Web API contrôleur
```
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";
        }  
    }
}
```
- Où sommes-nous exactement l'ajout de références à Système.Web.De routage, System.Web.Net et le Système.Net.Http?
- À partir de la boîte de Dialogue Ajouter une Référence, ouvrir le dialogue et de recherche pour les noms de ces assemblées, il ya une grande chance qu'ils sont déjà ajoutés. (mais juste pour être certain)
- Est la méthode Application_Start censé être une partie de la classe globale Mondiale.asax.cs?
- oui, j'ai mis à jour ma réponse à démontrer que, que vous pour la remarque
- Cela m'a aidé. Merci!!!!
InformationsquelleAutor Hakam Fostok
1

J'ai eu le même problème, la solution était si facile

Clic droit sur solotion
l'installation de Microsoft.ASP.NET.WebApi de "Gestion de Package Nuget pour Sulotion"

boom c'est tout 😉

InformationsquelleAutor tahaGhSa

Vous devez vous connecter pour publier un commentaire.