web-dev-qa-db-ja.com

Web API 2の戻り値の型

私はWebAPI 2のドキュメントを見ており、アクションの結果がどのように構築されているかについて、非常にがっかりしています。もっと良い方法があることを本当に望んでいます。

だからドキュメントは私がこれらを返すことができると言います：

**void**    Return empty 204 (No Content)

**HttpResponseMessage** Convert directly to an HTTP response message.

**IHttpActionResult**   Call ExecuteAsync to create an HttpResponseMessage, then convert to an HTTP response message.

**Other type**  Write the serialized return value into the response body; return 200 (OK).

ただし、カスタムHTTPステータスコード、カスタムヘッダー、および自動ネゴシエートされたコンテンツを含むアイテムの配列を返すきれいな方法がありません。

私が見たいのは次のようなものです

public HttpResult<Item> Post()
{
   var item = new Item();
   var result = new HttpResult<Item>(item, HttpStatusCode.Created);
   result.Headers.Add("header", "header value");

   return result;
}

このようにして、メソッドをちらっと見て、返されたものをすぐに確認し、ステータスコードとヘッダーを変更できます。

私が見つけた最も近いものはNegotiatedContentResult<T>で、奇妙な署名（なぜコントローラーのインスタンスが必要なのですか？）ですが、カスタムヘッダーを設定する方法はありませんか？

より良い方法はありますか？

c#asp.net-web-apiasp.net-web-api2
11
Evgeni

コントローラーメソッドがヘッダーをいじるのを目的としたweb-apiの設計者ではないと思います。デザインパターンは、認証と応答のフォーマットを処理するために DelegatingHandler 、 ActionFilterAttribute とApiControllerのExecuteAsyncオーバーライド可能なメソッドを使用するようです。

したがって、おそらくメッセージコンテンツネゴシエーションのロジックはそこで処理する必要がありますか？

ただし、コントローラーメソッド内からヘッダーを確実に制御する必要がある場合は、それを機能させるために少し設定を行うことができます。そのためには、「Inner」応答ヘッダーから選択したヘッダーを転送する独自のDelegationHandlerを作成できます。

public class MessageHandlerBranding : DelegatingHandler {
    protected async override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
    {
        var response = await base.SendAsync(request, cancellationToken);
        //If we want to forward headers from inner content we can do this:
        if (response.Content != null && response.Content.Headers.Any())
        {
            foreach (var hdr in response.Content.Headers)
            {
                var keyUpr = hdr.Key.ToUpper(); //Response will not tolerate setting of some header values
                if ( keyUpr != "CONTENT-TYPE" && keyUpr != "CONTENT-LENGTH")
                {
                    string val = hdr.Value.Any() ? hdr.Value.FirstOrDefault() : "";
                    response.Headers.Add(hdr.Key, val);                       
                }
            }
        }
        //Add our branding header to each response
        response.Headers.Add("X-Powered-By", "My product");
        return response;
    }  
}

次に、このハンドラーをweb-api構成に登録します。これは通常、GlobalConfig.csファイルにあります。

config.MessageHandlers.Add(new MessageHandlerBranding());

次のように、応答オブジェクト用の独自のカスタムクラスを作成することもできます。

public class ApiQueryResult<T> : IHttpActionResult where T : class
{
    public ApiQueryResult(HttpRequestMessage request)
    {
        this.StatusCode = HttpStatusCode.OK; ;
        this.HeadersToAdd = new List<MyStringPair>();
        this.Request = request;
    }

    public HttpStatusCode StatusCode { get; set; }
    private List<MyStringPair> HeadersToAdd { get; set; }
    public T Content { get; set; }
    private HttpRequestMessage Request { get; set; }

    public void AddHeaders(string headerKey, string headerValue)
    {
        this.HeadersToAdd.Add(new MyStringPair(headerKey, headerValue));
    }

    public Task<HttpResponseMessage> ExecuteAsync(CancellationToken cancellationToken)
    {
        var response = this.Request.CreateResponse<T>(this.StatusCode, this.Content);
        foreach (var hdr in this.HeadersToAdd)
        {
            response.Content.Headers.Add(hdr.key, hdr.value); 
        }
        return Task.FromResult(response);
    }


    private class MyStringPair
    {
        public MyStringPair(string key, string value)
        {
            this.key = key;
            this.value = value;
        }
        public string key;
        public string value;
    }
}

そしてそれをあなたのコントローラーでこのように使ってください：

 [HttpGet]
    public ApiQueryResult<CustomersView> CustomersViewsRow(int id)
    {
        var ret = new ApiQueryResult<CustomersView>(this.Request);
        ret.Content = this.BLL.GetOneCustomer(id);
        ret.AddHeaders("myCustomHkey","myCustomValue");
        return ret;
    }
10
Svakinn

次のコードはあなたが望むすべてを与えるはずです：

[ResponseType(typeof(Item))]
public IHttpActionResult Post()
{
    var item = new Item();
    HttpContext.Current.Response.AddHeader("Header-Name", "Header Value");
    return Content(HttpStatusCode.Created, item);
}

...本当にアイテムの配列を返す必要がある場合...

[ResponseType(typeof(List<Item>))]
public IHttpActionResult Post()
{
    var items = new List<Item>();
    // Do something to fill items here...
    HttpContext.Current.Response.AddHeader("Item-Count", items.Count.ToString());
    return Content(HttpStatusCode.Created, items);
}
10
afrazier