ASP.NET Web API 2 の構成

このトピックでは、ASP.NET Web API を構成する方法について説明します。

• 構成の設定
• ASP.NET ホスティングでの Web API の構成
• OWIN セルフホスティングでの Web API の構成
• グローバル Web API サービス
• コントローラーごとの構成

構成設定

Web API 構成の設定は、HttpConfiguration クラスで定義されています。

前提条件

Visual Studio 2017 Community、Professional、または Enterprise エディション。

ASP.NET ホスティングでの Web API の構成

ASP.NET アプリケーションで Web API を構成するには、Application_Start メソッドで GlobalConfiguration.Configure を呼び出します。 Configure メソッドは、HttpConfiguration 型の 1 つのパラメーターでデリゲートを受け取ります。 すべての構成はデリゲート内で実行します。

匿名デリゲートの使用例を次に示します。

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

Visual Studio 2017 では、[新しい ASP.NET プロジェクト] ダイアログで [Web API] を選ぶと、"ASP.NET Web アプリケーション" プロジェクト テンプレートによって構成コードが自動的に設定されます。

このプロジェクト テンプレートは、App_Start フォルダー内に WebApiConfig.cs という名前のファイルを作成します。 このコード ファイルでは、Web API 構成コードを配置する必要があるデリゲートが定義されています。

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

また、このプロジェクト テンプレートでは、Application_Start から デリゲートを呼び出すコードも追加されます。

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

OWIN セルフホスティングでの Web API の構成

OWIN を使ってセルフホスティングを行っている場合は、新しい HttpConfiguration インスタンスを作成します。 このインスタンスですべての構成を実行してから、そのインスタンスを 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); 
    } 
}

OWIN を使用した ASP.NET Web API 2 のセルフホストに関するチュートリアルで、完全な手順が示されています。

グローバル Web API サービス

HttpConfiguration.Services コレクションには、コントローラーの選択やコンテンツのネゴシエーションなど、さまざまなタスクを実行するために Web API が使うグローバル サービスのセットが含まれています。

Services コレクションは既定のサービスのセットで初期化され、ユーザーは独自のカスタム実装を提供できます。 複数のインスタンスをサポートするサービスと、インスタンスを 1 つしか持つことができないサービスがあります。 (ただし、コントローラー レベルでサービスを提供することもできます。「コントローラーごとの構成」をご覧ください。)

単一インスタンス サービス

複数インスタンス サービス

マルチインスタンス サービスにカスタム実装を追加するには、Services コレクションで Add または Insert を呼び出します。

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

単一インスタンス サービスをカスタム実装に置き換えるには、Services コレクションで Replace を呼び出します。

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

コントローラーごとの構成

次の設定はコントローラーごとにオーバーライドできます。

• メディアタイプ フォーマッタ
• パラメーター バインディング規則
• サービス

そのためには、IControllerConfiguration インターフェイスを実装するカスタム属性を定義します。 次に、属性をコントローラーに適用します。

次の例では、既定のメディアタイプ フォーマッタをカスタム フォーマッタに置き換えています。

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

IControllerConfiguration.Initialize メソッドは、2 つのパラメーターを受け取ります。

• HttpControllerSettings オブジェクト
• HttpControllerDescriptor オブジェクト

HttpControllerDescriptor にはコントローラーの説明が含まれており、情報を得るために調べることができます (たとえば、2 つのコントローラーを区別するため)。

コントローラーを構成するには、HttpControllerSettings オブジェクトを使います。 このオブジェクトには、コントローラーごとにオーバーライドできる構成パラメーターのサブセットが含まれています。 変更しない設定は、既定でグローバル HttpConfiguration オブジェクトに設定されます。