Trang trợ giúp được tạo tự động với kiểu trả về HttpResponseMessage

Question

Tôi sẽ đánh giá cao một số giải thích về trang trợ giúp tự động tạo trang web api.

Theo như tôi có thể hiểu, nếu tôi trả về Loại, nó sẽ tự động tạo trang trợ giúp cho hành động đó bằng một ví dụ. Nhưng nếu tôi sử dụng HttpResponseMessage thì dễ hiểu là nó không thể đoán được phản hồi sẽ là gì và chỉ có thể đưa ra các giả định về các tham số yêu cầu.

Lý do tôi đã sử dụng HttpResponseMessage được vì nó đã được đề nghị để chỉ ra mã trạng thái mà bạn muốn quay trở lại khi nó có thể khác với 200.

Vì vậy phương pháp thực hành tốt nhất là những gì để có thể trở lại mã trạng thái mong muốn của bạn, nhưng vẫn có các trang trợ giúp làm việc ra các loại bạn đang quay trở lại?

Answer 1

Đối với các trường hợp này, nơi bạn cần trả về HttpResponseMessage, giải pháp thay thế là chỉ ra loại trả về thực tế của hành động cụ thể đó bằng cách sử dụng một số trợ giúp mà HelpPage cung cấp. Bạn có thể tìm đoạn mã sau trong đường dẫn Areas\HelpPage\App_Start\HelpPageConfig.cs

//// 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"); 

Note:
Trong phiên tới, chúng tôi đang giới thiệu một thuộc tính mới gọi là System.Web.Http.Description.ResponseTypeAttriute mà bạn có thể cung cấp một System.Type cho thấy các loại thực tế của phản ứng . Bằng cách này, bạn có thể trả lại HttpResponseMessage hoặc IHttpActionResult từ hành động của mình và vẫn mong đợi HelpPage hoạt động.

Answer 2

Tôi nghĩ Thuộc tính là một ý tưởng tuyệt vời và vì vậy tôi đã triển khai thuộc tính có thể giúp người khác cho đến khi các bạn phát hành nó.

Trang trí hành động của bạn với các thuộc tính:

public class FooController : ApiController 
{ 
    [ResponseType(typeof(Bar))] 
    public HttpResponseMessage Get(string id) 
    { 
     // ... 
    } 
} 

Xác định các thuộc tính:

[AttributeUsage(AttributeTargets.Method, AllowMultiple = false)] 
public class ResponseTypeAttribute : Attribute 
{ 
    public ResponseTypeAttribute(Type type) 
    { 
     if (type == null) 
     { 
      throw new ArgumentNullException("type"); 
     } 

     Type = type; 
    } 

    public Type Type { get; private set; } 
} 

Xác định phương pháp để đăng ký các loại phản ứng:

/// <summary> 
///  Registers api controller actions which return HttpResponseMessage 
///  and include the ResponseType attribute to be populated with web api 
///  auto generated help. 
/// </summary> 
/// <param name="assembly">The assembly to search for</param> 
public static void RegisterHelpResponseTypes(Assembly assembly) 
{ 
    var apiControllerTypes = assembly 
     .GetTypes().Where(typeof(ApiController).IsAssignableFrom); 

    foreach (var apiControllerType in apiControllerTypes) 
    { 
     var validActions = apiControllerType.GetMethods() 
      .Where(method => 
       Attribute.IsDefined(method, typeof(ResponseTypeAttribute)) 
       && 
       (method.ReturnType == typeof(HttpResponseMessage))); 

     foreach (var action in validActions) 
     { 
      var responseType = (ResponseTypeAttribute)Attribute 
            .GetCustomAttributes(action) 
            .Single(x => x is ResponseTypeAttribute); 

      var controllerName = apiControllerType.Name.Substring(0, 
        apiControllerType.Name.LastIndexOf("Controller", 
             StringComparison.OrdinalIgnoreCase)); 
      var actionName = action.Name; 

      GlobalConfiguration 
       .Configuration 
       .SetActualResponseType(responseType.Type, 
             controllerName, 
             actionName); 
     } 
    } 
} 

Bao gồm nó trên ứng dụng của bạn bắt đầu:

RegisterHelpResponseTypes(typeof(FooController).Assembly); 

Vui lòng cho tôi biết nếu bạn tìm thấy bất kỳ vấn đề nào.

Answer 3

MVC 5 có thuộc tính tích hợp để đặt loại phản hồi.

biết thêm thông tin ở đây: http://thesoftwaredudeblog.wordpress.com/2014/01/05/webapi-2-helppage-using-responsetype-attribute-instead-of-setactualresponsetype/

Chỉ cần sử dụng:

ResponseType(typeof([Your_Class]))]