Configurazione dell'API Web ASP.NET 2

Questo argomento descrive come configurare ASP.NET'API Web.

• Impostazioni di configurazione
• Configurazione dell'API Web con hosting ASP.NET
• Configurazione dell'API Web con auto-hosting OWIN
• Servizi API Web globali
• Configurazione diPer-Controller

Impostazioni di configurazione

Le impostazioni di configurazione dell'API Web sono definite nella classe HttpConfiguration .

Prerequisiti

Visual Studio 2017 Community, Professional o Enterprise Edition.

Configurazione dell'API Web con hosting ASP.NET

In un'applicazione ASP.NET configurare l'API Web chiamando GlobalConfiguration.Configure nel metodo Application_Start . Il metodo Configure accetta un delegato con un singolo parametro di tipo HttpConfiguration. Esegui la configurazione completa all'interno del delegato.

Di seguito è riportato un esempio di uso di un delegato anonimo:

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

In Visual Studio 2017 il modello di progetto "applicazione Web ASP.NET" configura automaticamente il codice di configurazione, se si seleziona "API Web" nella finestra di dialogo Nuovo progetto ASP.NET .

Il modello di progetto crea un file denominato WebApiConfig.cs all'interno della cartella App_Start. Questo file di codice definisce il delegato in cui inserire il codice di configurazione dell'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 }
            );
        }
    }
}

Il modello di progetto aggiunge anche il codice che chiama il delegato da Application_Start.

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

Configurazione dell'API Web con OWIN Self-Hosting

Se esegui l'hosting autonomo con OWIN, crea una nuova istanza HttpConfiguration. Eseguire qualsiasi configurazione in questa istanza e quindi passare l'istanza al metodo di estensione 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); 
    } 
}

L'esercitazione Usare OWIN per Self-Host ASP.NET'API Web 2 illustra i passaggi completi.

Servizi API Web globali

La raccolta HttpConfiguration.Services contiene un set di servizi globali usati dall'API Web per eseguire varie attività, ad esempio la selezione del controller e la negoziazione del contenuto.

La raccolta Services viene inizializzata con un set predefinito di servizi ed è possibile fornire implementazioni personalizzate. Alcuni servizi supportano più istanze, mentre altre possono avere una sola istanza. Tuttavia, è anche possibile fornire servizi a livello di controller; vedere Configurazione per controller.

Servizi a Istanza Unica

Servizi Multi-Istanza

Per aggiungere un'implementazione personalizzata a un servizio a istanze multipla, chiamare Aggiungi o Inserisci nella raccolta Services :

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

Per sostituire un servizio a istanza singola con un'implementazione personalizzata, chiamare Replace nella raccolta Services :

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

Configurazione di Per-Controller

È possibile eseguire l'override delle impostazioni seguenti in base al controller:

• Formattatori di tipo multimediale
• Regole di associazione dei parametri
• Servizi

A tale scopo, definire un attributo personalizzato che implementa l'interfaccia IControllerConfiguration . Applicare quindi l'attributo al controller.

L'esempio seguente sostituisce i formattatori di tipo multimediale predefiniti con un formattatore personalizzato.

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...
    }
}

Il metodo IControllerConfiguration.Initialize accetta due parametri:

• HttpControllerSettings oggetto
• Oggetto HttpControllerDescriptor

HttpControllerDescriptor contiene una descrizione del controller, che è possibile esaminare per scopi informativi, ad esempio per distinguere tra due controller.

Utilizzare l'oggetto HttpControllerSettings per configurare il controller. Questo oggetto contiene il subset di parametri di configurazione di cui è possibile eseguire l'override in base al controller. Qualsiasi impostazione che non modifichi utilizzerà, per impostazione predefinita, l'oggetto HttpConfiguration globale.