带有模板类的Web API帮助页面

时间:2014-07-21 14:56:27

标签: asp.net-web-api2 xml-documentation asp.net-web-api-helppages

我有一个ASP.NET Web API,它返回一个模板类,但我无法通过Web API帮助页面正确地提供返回类型的文档。

假设我有以下模型类:

public class MyType<T>
{
  /// <summary>A list of T</summary>
  public List<T> MyList { get; set; }
}
public class Foo
{
  /// <summary>Bar string</summary>
  public string Bar { get; set; }
}

我的API操作如下所示

[ResponseType(typeof(MyType<Foo>))]
public IHttpActionResult Get()
{
  return Ok<MyType<Foo>>(new MyType<Foo>());
}

生成的Web API帮助页面然后声明Get操作返回MyTypeOfFoo并且不提供MyType的XML文档,它只列出它包含的参数。可能是因为它不理解MyTypeOfFooMyType<Foo>相同。 这个问题有没有已知的解决方案?

更新

创建一个伪类并返回它也不起作用。 E.g。

/// <summary>My Foo Type</summary>
public class MyFooType : MyType<Foo>
{
}

[ResponseType(typeof(MyFooType)]
public IHttpActionResult Get()
{
  return Ok<MyFooType>(new MyFooType());
}

上述代码的文档输出缺少继承属性的可用注释。

0 个答案:

没有答案