ASP Web APIで無効なパラメータが指定された場合にエラーを返します

Question

C＃およびASP.NET Web APIを使用してAPIを作成していますが、パラメータが認識されない場合にエラーを返すようにします。例えば

：エラーを返す必要があり

/api/Events 

イベント

/api/Events?startTime={{startTime}} 

のリストは、特定の時間に

/api/Events?someRandomInvalidParameter={{something}} 

を開始したイベントのリストを返す必要がありますする必要があり

これを行うには良い設定方法がありますか？そうでない場合は、どのように自分自身をチェックするためのパラメータのリストを得ることができます。

Answer 1

の順序によってチェック/管理する必要があります。

public class InvalidQueryStringRejectorAttribute : ActionFilterAttribute 
{ 
    public override void OnActionExecuting(HttpActionContext actionContext) 
    { 
     var arguments = actionContext.ActionArguments.Keys; 

     var queryString = actionContext.Request.GetQueryNameValuePairs() 
      .Select(q => q.Key); 

     var invalidParams = queryString.Where(k => !arguments.Contains(k)); 

     if (invalidParams.Any()) 
     { 
      actionContext.Response = actionContext.Request.CreateResponse(HttpStatusCode.BadRequest, new 
      { 
       message = "Invalid query string parameters", 
       parameters = invalidParams 
      }); 
     } 
    } 
} 

フィルタは、メソッドのシグネチャと一致しないクエリ文字列パラメータを持つすべての要求を拒否すること。

[InvalidQueryStringRejector] 
public IHttpActionResult Get(string value) 
{ 
    return Ok(value); 
} 

またはあなたのHttpConfigurationオブジェクト内に登録することにより、任意のアクションに適用されます：

config.Filters.Add(new InvalidQueryStringRejectorAttribute()); 

Answer 2

だから、通常の呼び出しが返されます、私は生きているか、私は生きている空

http://localhost:1578/api/alive?id=1 //OR 
    http://localhost:1578/api/alive 

しかし、あなたはこの

ようにそれを呼び出すようにしようとした場合、この

public string Get() 
     { 
      return "I'm alive empty"; 
     } 

    public string Get([FromUri] int id) 
     { 
      return "I'm alive"; 
     } 

のような強く型付けされたアクションを試してみてください

http://localhost:1578/api/alive?blablabla=1 

このエラーが発生する可能性があります。 要求されたリソースは、httpメソッド 'GET'をサポートしていません。

Answer 3

私はあなたが
例オーバーライドメソッドされるべきだと思う：

[Route("/app/Events/{startTime})"] 
public ApiResponse Get(string startTime) 
{ 
} 

[Route("/app/Events/{startTime}/{someRandomeInvalid}")] 
public ApiResponse Get(string startTime, string someRandomeInvalid) 
{ 
} 

明示的にパラメータ名を設定しないでください。あなたはこれを自動化するActionFilterを作成することができ、パラメータ