ASP.NET trang Web API giúp đỡ - làm thế nào để hiển thị kiểu trả về generic trong tài liệu

Question

Tôi đang sử dụng một kiểu generic trở lại cho tất cả các phản ứng api của tôi:

public HttpStatusCode statusCode { get; set; } 
    public string error { get; set; } 
    public IDictionary<string, string> errorfor { get; set; } 
    public T result { get; set; } 

và trong API:

/// <summary> 
/// GET Order API 
/// </summary> 
/// <returns> return list of orders {Order} </returns> 

public HttpResponseMessage Get(){ 
    var response = new BaseResponseMessage<IList<Order>>(); 
    //some more codes 
    response.result = orders; 
    return Request.CreateResponse(HttpStatusCode.OK, response); 
} 

Bây giờ tất nhiên trang Trợ giúp API của tôi không hiển thị Đơn đặt hàng trong nội dung Phản hồi mẫu. Có thể định cấu hình trình tạo Trang trợ giúp để hiển thị loại chung không? Cảm ơn!

Answer 1

Nó sẽ không thể cho HelpPage để đoán những gì sẽ là loại trở lại của một hành động chỉ với chữ ký mà bạn có. Như bạn đã biết, thế hệ HelpPage không xảy ra trong khi yêu cầu bình thường, nhưng là cái gì đó phụ thuộc vào thông tin tĩnh.

Có một giải pháp thay thế cho điều này. Bạn có thể xem mã nhận xét sau trong Areas\HelpPage\App_Start\HelpPageConfig.cs cho phép bạn chỉ định loại trả lại cụ thể cho một hành động.

//// Uncomment the following to correct the sample response when the action returns an HttpResponseMessage with ObjectContent<string>. 
//// The sample will be generated as if the controller named "Values" and action named "Post" were returning a string. 
//config.SetActualResponseType(typeof(string), "Values", "Post"); 

Tôi hiểu rằng cách giải quyết này sẽ quá cồng kềnh vì bạn đã đề cập đến việc có loại chữ ký này cho tất cả các hành động của bạn.

Bạn có thể mở rộng HelpPage bằng cách tạo thuộc tính tùy chỉnh thông báo về kiểu trả về và trang trí nó trên các hành động. Sau đó bạn có thể sửa đổi mã HelpPage đã cài đặt để tìm các thuộc tính này.

Answer 2

Web API 2.1 Trợ giúp Trang hiện nay làm được điều này: http://www.asp.net/web-api/overview/releases/whats-new-in-aspnet-web-api-21#help-page

Bạn cũng có thể kiểm tra trở về tiêu chuẩn HttpResponseMessage với mới ResponseTypeAttribute:

/// <summary> 
/// GET Order API 
/// </summary> 
[ResponseType(typeof(List<Order>))] 
public HttpResponseMessage Get() 
{ 
    var orders = new List<Order>(); 
    return Request.CreateResponse(HttpStatusCode.OK, orders); 
}