ASP.. NET Web API帮助页不能处理泛型控制器

本文关键字：不能 处理 泛型 控制器 帮助 NET Web API ASP | 更新日期: 2023-09-27 18:09:59

我有一个关于ASP的问题。. NET Web API帮助页。

通常帮助页可以通过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()中，与第一个

相比，注释不显示。

有解决这些问题的办法吗?

ASP.. NET Web API帮助页不能处理泛型控制器

我能够通过调整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;
}
....

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

相关文章：