Question

我对ASP.NET Web API帮助页面有疑问。

通常，HelpPages可以通过XMLDocumentation生成WebAPI 示例代码：

public class ValueControllerBase : ApiController
{
    /// <summary>
    /// Base Do
    /// </summary>
    public IEnumerable<string> Do()
    {
       return new string[] { "value1", "value2" };
    }
}

public class ValuesController : ValueControllerBase
{
    /// <summary>
    /// Testing API
    /// </summary>
    public string Get(int id)
    {
        return "value";
    }
}

这可以成功生成，如下所示：

API
GET api/Values/Get/{id}

Description
Testing API

API
POST api/Values/Do

Description
Base Do

但如果我使用通用基本控制器，它将不会生成API文档。

样品：

public class ValueControllerBase<T> : ApiController
{
    /// <summary>
    /// Base Do
    /// </summary>
    public IEnumerable<string> Do()
    {
        return new string[] { "value1", "value2" };
    }
}

public class ValuesController<String> : ValueControllerBase
{
    /// <summary>
    /// Testing API
    /// </summary>
    public string Get(int id)
    {
        return "value";
    }
}

如果我在第二部分使用代码，HelpPages可以生成API文档，但不会生成API注释。我的两个例子之间的区别只是第二部分代码使用泛型类型。

API
GET api/Values/Get/{id}  

Description
Testing API

API
POST api/Values/Do

Description
null

在方法Do()中，注释与第一个相比没有显示

有解决这些问题的方法吗？

Answer 1

我能够通过调整XmlDocumentationProvider中的一些代码来解决这个问题。

XmlDocumentationProvider.GetTypeName(Type)的原始实现如下：

private static string GetTypeName(Type type)
{
    string name = type.FullName;
    if (type.IsGenericType)
    {
        // Format the generic type name to something like: Generic{System.Int32,System.String}
        Type genericType = type.GetGenericTypeDefinition();
        Type[] genericArguments = type.GetGenericArguments();
        string genericTypeName = genericType.FullName;

        // Trim the generic parameter counts from the name
        genericTypeName = genericTypeName.Substring(0, genericTypeName.IndexOf('`'));
        string[] argumentTypeNames = genericArguments.Select(t => GetTypeName(t)).ToArray();
        name = String.Format(CultureInfo.InvariantCulture, "{0}{....
if (type.IsGenericType)
{
    Type genericType = type.GetGenericTypeDefinition();
    name = genericType.FullName;
}
....
}", genericTypeName, String.Join(",", argumentTypeNames));
    }
    if (type.IsNested)
    {
        // Changing the nested type name from OuterType+InnerType to OuterType.InnerType to match the XML documentation syntax.
        name = name.Replace("+", ".");
    }

    return name;
}

我不知道为什么，但是他们尝试为xml查找创建类型名称以包含实际的通用属性，而不是泛型类型名称本身（例如，他们创建Nullable {bool}而不是Nullable`1）。在xml文件中只定义了通用名称本身。

对代码的简单更改使其能够正确地命名/引用泛型类的文档：

{{1}}

进行更改后，注释开始正确显示为泛型类型，对我而言，这并没有打破其他任何内容。

ASP.NET Web API帮助页面无法处理通用类型控制器

1 个答案: