C# ASP.NET Web APIにおけるFromBody属性とFromUri属性の違いとは？

ASP.NET Web APIがコントローラーのメソッドを呼び出す際には、パラメータに値を設定する必要があります。この一連の処理は「パラメータバインディング」と呼ばれます。

通常、モデル（アクションパラメータ）はフォーマッターによってバインドされるのがデフォルトの動作ですが、URIから値を取得してバインドしたい場合は[FromUri]属性を付与します。FromUriAttributeはModelBinderAttributeを継承したクラスであり、Web APIに対して「IUriValueProviderFactoryで定義されたValueProvidersを使ってURIから特定のパラメータを取得せよ」と指示するショートカット的な役割を果たします。この属性自体はsealed（継承不可）として定義されているため、それ以上拡張することはできませんが、カスタムのIUriValueProviderFactoryであれば必要な数だけ追加することが可能です。

一方、[FromBody]属性はParameterBindingAttributeクラスを継承しており、HTTPリクエストのボディからパラメータおよびそのプロパティへ値を設定するために使用されます。ASP.NETランタイムは、リクエストボディの読み取り処理をインプットフォーマッターに委譲します。なお、[FromBody]を複合型のパラメータに適用した場合、そのプロパティに付けられたバインディングソース属性はすべて無視されるという点に注意が必要です。

FromUri属性の使用例

以下は、Getアクションメソッドのパラメータに[FromUri]属性を適用した例です。

using System.Collections.Generic;
using System.Web.Http;
namespace DemoWebApplication.Controllers{
    public class DemoController : ApiController{
        public IEnumerable<string> Get([FromUri] string id, [FromUri] string name){
            return new string[]{
                $"The Id of the Student is {id}",
                $"The Name of the Student is {name}"
            };
        }
    }
}

上記の例では、URIにidとnameの値を渡すことで、Getメソッド内の対応する変数にそれぞれの値が設定されます。

https://localhost:58174/api/demo?id=1&name=Mark

実行結果

上記コードの出力結果は以下の通りです。

FromBody属性の使用例

次に、以下のプロパティを持つStudentモデルを作成します。

namespace DemoWebApplication.Models{
    public class Student{
        public int Id { get; set; }
        public string Name { get; set; }
    }
}

コントローラーコード

using DemoWebApplication.Models;
using System.Collections.Generic;
using System.Web.Http;
namespace DemoWebApplication.Controllers{
    public class DemoController : ApiController{
        public IEnumerable<string> Get([FromBody] Student student){
            return new string[]{
                $"The Id of the Student is {student.Id}",
                $"The Name of the Student is {student.Name}"
            };
        }
    }
}

上記の例では、studentの値はリクエストボディ経由で渡され、Studentオブジェクトの対応する各プロパティに自動的にマッピングされます。以下は、Postmanを使用した場合のリクエストとレスポンスの例です。