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

En supposant que vous ayez oublié de cocher la case API Web (ajoutez-la au projet) lors de la création d'un nouveau projet MVC (5), que devez-vous faire pour ajouter l'API Web et la faire fonctionner?

Il y a un tas de questions sur la migration, mais aucune ne semblait avoir les étapes complètes et à jour pour ajouter l'API Web à un projet MVC 5 et cela semble avoir changé par rapport à certaines des anciennes réponses.

Ajouter l'API Web à MVC 4

Ajout de GlobalConfiguration.Configure (WebApiConfig.Register) MVC 4

Mettre à jour le projet MVC

Utilisez Nuget pour obtenir la dernière API Web.

Projet - Clic droit - Gérer les packages Nuget - Recherchez l'API Web (API Web Microsoft ASP.NET ...) et installez-la dans votre projet MVC.

Ensuite, vous devez toujours faire fonctionner le routage API Web . À partir de l'API Web 2 de configuration d'ASP.NET de Microsoft

Ajouter WebApiConfig.cs au dossier App_Start /

using System.Web.Http;

namespace WebApplication1
{
    public static class WebApiConfig
    {
        public static void Register(HttpConfiguration config)
        {
            // TODO: Add any additional configuration code.

            // Web API routes
            config.MapHttpAttributeRoutes();

            config.Routes.MapHttpRoute(
                name: "DefaultApi",
                routeTemplate: "api/{controller}/{id}",
                defaults: new { id = RouteParameter.Optional }
            );

        // WebAPI when dealing with JSON & JavaScript!
        // Setup json serialization to serialize classes to camel (std. Json format)
        var formatter = GlobalConfiguration.Configuration.Formatters.JsonFormatter;
        formatter.SerializerSettings.ContractResolver =
            new Newtonsoft.Json.Serialization.CamelCasePropertyNamesContractResolver();
        }
    }
}

Si vous avez un projet MVC, il aura Global.asax.cs , ajoutez les nouvelles routes. L'ordre des routes Global.asax.cs est critique. Notez qu'il existe des exemples obsolètes qui utilisent WebApiConfig.Register

Ajoutez cette ligne à Global.asax.cs: GlobalConfiguration.Configure(WebApiConfig.Register);

protected void Application_Start()
{
    // Default stuff
    AreaRegistration.RegisterAllAreas();

    // Manually installed WebAPI 2.2 after making an MVC project.
    GlobalConfiguration.Configure(WebApiConfig.Register); // NEW way
    //WebApiConfig.Register(GlobalConfiguration.Configuration); // DEPRECATED

    // Default stuff
    FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
    RouteConfig.RegisterRoutes(RouteTable.Routes);
    BundleConfig.RegisterBundles(BundleTable.Bundles);
}

Aide WebAPI

Pour obtenir les pages d'aide ( très ) utiles de WebAPI , installez WebAPI.HelpPage. Voir http://channel9.msdn.com/Events/Build/2014/3-644 (~ 42 minutes) pour ce qu'il fait. Cela semble très utile!

Console Nuget: Install-Package Microsoft.AspNet.WebApi.HelpPage

Pour vérifier que WebAPI fonctionne:

Dans le dossier des contrôleurs -> Ajouter un nouvel élément -> Classe de contrôleur API Web.

public class TestController : ApiController
{
    //public TestController() { }

    // GET api/<controller>
    public IEnumerable<string> Get()
    {
        return new string[] { "value1", "value2" };
    }

    // GET api/<controller>/5
    public string Get(int id)
    {
        return "value";
    }
    //...
}

Vous pouvez maintenant tester dans IE / FF / Chrome comme d'habitude, ou dans les consoles JavaScript pour les tests non-get.

(Avec juste le contrôleur dans l'URL, il appellera l'action GET () dans le nouveau contrôleur API Web, il est automatiquement mappé aux méthodes / actions en fonction du REST, par exemple PUT / POST / GET / DELETE. Vous n'avez pas besoin d'appeler les par action comme dans MVC) L'URL directement:

http://localhost:PORT/api/CONTROLLERNAME/

Vous pouvez également utiliser jQuery pour interroger le contrôleur. Exécutez le projet, ouvrez la console (F12 dans IE) et essayez d'exécuter une requête Ajax. (Vérifiez votre PORT & CONTROLLERNAME)

$.get( "http://localhost:PORT/api/CONTROLLERNAME/", function( data ) {
    //$( ".result" ).html( data );
    alert( "Get data received:" + data);
});

Remarque: il y a quelques avantages / inconvénients à prendre en compte lors de la combinaison de MVC et d'API Web dans un projet

Vérification de l'aide WebAPI: http://localhost:PORT/help