Configuration de API Web ASP.NET 2

Cette rubrique explique comment configurer API Web ASP.NET.

• Paramètres de configuration
• Configuration de l’API web avec l’hébergement ASP.NET
• Configuration de l’API web avec L’auto-hébergement OWIN
• Services d’API web globaux
• Configuration par contrôleur

Paramètres de configuration

Les paramètres de configuration de l’API web sont définis dans la classe HttpConfiguration .

Prérequis

Visual Studio 2017 édition Communauté, Professionnel ou Entreprise.

Configuration de l’API web avec l’hébergement ASP.NET

Dans une application ASP.NET, configurez l’API web en appelant GlobalConfiguration.Configure dans la méthode Application_Start . La méthode Configure accepte un délégué avec un paramètre unique de type HttpConfiguration. Effectuez toute votre configuration à l’intérieur du délégué.

Voici un exemple d’utilisation d’un délégué anonyme :

using System.Web.Http;
namespace WebApplication1
{
    public class WebApiApplication : System.Web.HttpApplication
    {
        protected void Application_Start()
        {
            GlobalConfiguration.Configure(config =>
            {
                config.MapHttpAttributeRoutes();

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

Dans Visual Studio 2017, le modèle de projet « application web ASP.NET » configure automatiquement le code de configuration, si vous sélectionnez « API web » dans la boîte de dialogue Nouveau projet ASP.NET .

Le modèle de projet crée un fichier nommé WebApiConfig.cs à l’intérieur du dossier App_Start. Ce fichier de code définit le délégué dans lequel vous devez placer le code de configuration de votre API web.

using System;
using System.Collections.Generic;
using System.Linq;
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 }
            );
        }
    }
}

Le modèle de projet ajoute également le code qui appelle le délégué à partir de Application_Start.

public class WebApiApplication : System.Web.HttpApplication
{
    protected void Application_Start()
    {
        GlobalConfiguration.Configure(WebApiConfig.Register);
    }
}

Configuration de l’API web avec Self-Hosting OWIN

Si vous vous auto-hébergez avec OWIN, créez une nouvelle instance HttpConfiguration. Effectuez une configuration sur ce instance, puis passez le instance à la méthode d’extension Owin.UseWebApi.

public class Startup 
{ 
    public void Configuration(IAppBuilder appBuilder) 
    { 
        HttpConfiguration config = new HttpConfiguration(); 

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

        appBuilder.UseWebApi(config); 
    } 
}

Le didacticiel Utiliser OWIN pour Self-Host API Web ASP.NET 2 montre les étapes complètes.

Services d’API web globaux

La collection HttpConfiguration.Services contient un ensemble de services globaux que l’API web utilise pour effectuer diverses tâches, telles que la sélection du contrôleur et la négociation du contenu.

La collection Services est initialisée avec un ensemble de services par défaut et vous pouvez fournir vos propres implémentations personnalisées. Certains services prennent en charge plusieurs instances, tandis que d’autres ne peuvent avoir qu’une seule instance. (Toutefois, vous pouvez également fournir des services au niveau du contrôleur ; consultez Configuration par contrôleur.

Single-Instance Services

Multiple-Instance Services

Pour ajouter une implémentation personnalisée à un service multi-instance, appelez Ajouter ou Insérer dans la collection Services :

config.Services.Add(typeof(IFilterProvider), new MyFilterProvider());

Pour remplacer un service à instance unique par une implémentation personnalisée, appelez Replace sur la collection Services :

config.Services.Replace(typeof(ITraceWriter), new MyTraceWriter());

configuration Per-Controller

Vous pouvez remplacer les paramètres suivants par contrôleur :

• Formateurs de type multimédia
• Règles de liaison de paramètre
• Services

Pour ce faire, définissez un attribut personnalisé qui implémente l’interface IControllerConfiguration . Ensuite, appliquez l’attribut au contrôleur.

L’exemple suivant remplace les formateurs de type multimédia par défaut par un formateur personnalisé.

using System;
using System.Web.Http;
using System.Web.Http.Controllers;

namespace WebApplication1.Controllers
{

    public class UseMyFormatterAttribute : Attribute, IControllerConfiguration
    {
        public void Initialize(HttpControllerSettings settings,
            HttpControllerDescriptor descriptor)
        {
            // Clear the formatters list.
            settings.Formatters.Clear();

            // Add a custom media-type formatter.
            settings.Formatters.Add(new MyFormatter());
        }
    }

    [UseMyFormatter]
    public class ValuesController : ApiController
    {
        // Controller methods not shown...
    }
}

La méthode IControllerConfiguration.Initialize prend deux paramètres :

• Objet HttpControllerSettings
• Objet HttpControllerDescriptor

HttpControllerDescriptor contient une description du contrôleur, que vous pouvez examiner à des fins d’information (par exemple, pour faire la distinction entre deux contrôleurs).

Utilisez l’objet HttpControllerSettings pour configurer le contrôleur. Cet objet contient le sous-ensemble de paramètres de configuration que vous pouvez remplacer par contrôleur. Tous les paramètres que vous ne modifiez pas par défaut en l’objet HttpConfiguration global.