Automatycznie generowane strony pomocy z typem powrotu HttpResponseMessage

Question

Byłbym wdzięczny za wyjaśnienia na temat stron pomocy generowanych automatycznie przez web api.

O ile rozumiem, jeśli zwrócę typ, automatycznie wygeneruje stronę pomocy dla tego działania na przykładzie. Ale jeśli używam HttpResponseMessage, to jest zrozumiałe, że nie może odgadnąć, jaka będzie odpowiedź, i może jedynie przyjąć założenia dotyczące parametrów żądania.

Powodem używałem HttpResponseMessage ponieważ był polecany do wskazania kodu statusu chcesz wrócić, kiedy może to być inny niż 200.

So co to podejście najlepsze praktyki, aby móc powrócić pożądane kody statusu, ale nadal masz strony pomocy na temat typów, które powracasz?

Answer 1

W przypadku tych scenariuszy, w których należy zwrócić komunikat HttpResponseMessage, obejście to wskazuje rzeczywisty typ zwracania tej konkretnej czynności za pomocą niektórych pomocników udostępnianych przez pomoc. można znaleźć następujący kod w ścieżce 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"); 

Uwaga:
W nadchodzącym wydaniu wprowadzamy nowy atrybut o nazwie System.Web.Http.Description.ResponseTypeAttriute do których można dostarczać System.Type wskazujący rzeczywistą typ odpowiedzi . W ten sposób możesz zwrócić HttpResponseMessage lub IHttpActionResult ze swojej akcji i nadal oczekiwać działania HelpPage.

Answer 2

Myślę, że atrybut jest świetnym pomysłem i dlatego zaimplementowałem atrybut, który może pomóc innym, dopóki go nie wypuścicie.

Udekoruj swoje działania z atrybutem:

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

Definiowanie atrybutu:

[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; } 
} 

zdefiniować metodę zarejestrować typy reakcji:

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

umieścić go na swojej aplikacji początek:

RegisterHelpResponseTypes(typeof(FooController).Assembly); 

Proszę dać mi znać, jeśli znajdziesz jakieś problemy.

Answer 3

MVC 5 ma wbudowany atrybut, aby ustawić typ odpowiedzi.

Więcej informacji tutaj: http://thesoftwaredudeblog.wordpress.com/2014/01/05/webapi-2-helppage-using-responsetype-attribute-instead-of-setactualresponsetype/

Wystarczy użyć:

ResponseType(typeof([Your_Class]))]