8

我有一个关于 ASP.NET Web API HelpPages 的问题。

通常 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()中，与第一个相比，注释不显示

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

4

1 回答 1

14

我可以通过调整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}{{{1}}}", 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 文件中只定义了通用名称本身。

对代码进行简单的更改即可正确命名/引用泛型类的文档：

....
if (type.IsGenericType)
{
    Type genericType = type.GetGenericTypeDefinition();
    name = genericType.FullName;
}
....

进行更改后，泛型类型的注释开始正确显示，对我来说，这也没有破坏其他任何东西。

于 2014-12-19T16:52:20.147 回答