webdevqa.jp.net

WebAPIにクエリ文字列パラメーターを認識させる方法

ASP.NET MVC4 Web APIv1コントローラーを以下に定義します。 1つまたは2つのクエリ文字列パラメータを受け入れる必要があります。

ただし、メソッドが呼び出された場合、koパラメーターは常にnullになります。リクエストは以下の通りです。 klientまたはnamepartパラメーターがクエリ文字列で渡されるように修正するにはどうすればよいですか?

Web API v1コントローラー:

namespace MyApp.Controllers
{
    public class CustomersSearchViewModel
    {
        public string Klient { get; set; }
        public string Namepart { get; set; }
    }


    [Authorize]
    public class CustomersController : ApiController
        {

        public HttpResponseMessage Get(CustomersSearchViewModel ko)
            {
             // why ko is null ?         
             var res = GetCustomers(ko.Klient,ko.Namepart);
             return Request.CreateResponse(HttpStatusCode.OK, 
                    new { customers = res.ToArray() } );
            }

        }
    }

コントローラはリクエストによって呼び出されます(applはerp仮想ディレクトリから実行されています):

GET /erp/api/customers?namepart=kaks&_=1385320904347 HTTP/1.1
Host: localhost:52216
Connection: keep-alive
Accept: application/json, text/javascript, */*; q=0.01
X-Requested-With: XMLHttpRequest
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Referer: http://localhost:52216/erp/Sale
Accept-Encoding: gzip,deflate,sdch
Accept-Language: et-EE,et;q=0.8,en-US;q=0.6,en;q=0.4
Cookie: .myAuth=8B6B3CFFF3DF64EBEF3D258240D217C56603AF255C869FBB7934560D9F560659342DC4D1EAE6AB28454122A86C3CE6C598FB594E8DC84A; My_Session=5aw2bsjp4i4a5vxtekz

デフォルトのルーティングが使用されます:

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

Web API v.2を使用できないように、アプリケーションはWindows2003サーバーでも実行する必要があります。

更新

私も試しました

public HttpResponseMessage Get(string klient, string namepart)

しかし、この場合、404エラーが返され、アクションは見つかりません。

13
Andrus

複合型はリクエストの本文からフェッチされますが、次のようにこのデフォルトの動作を変更できます。

public HttpResponseMessage Get([FromUri]CustomersSearchViewModel ko)

クエリ文字列には、モデルプロパティと同じ名前のパラメータが含まれている必要があります。含まれていない場合、バインディングは機能しません。

19
Réda Mattar

別のオプションは、カスタムタイププロバイダーを実装することです。これにより、クエリ文字列の表現を制御できるようになり、アクションメソッドに[FromUri]属性を追加する必要がなくなります。これは、複雑なパラメータタイプを広く再利用している場合、またはカスタム表現が必要な場合に意味があります。

この良い例を このブログ投稿 に示します。ここでは、緯度と経度の場所が両方の手法を使用して実装されています。

1
Drew Noakes