记录复杂类型的描述

Question

在我的 API 中，我试图记录不同的字段描述，但似乎没有一个属性起作用。我知道这个功能应该是最近在 WebAPI 5.1 中实现的（运行 WebAPI.HelpPage 5.1.2）。

ASP.Net Web API Help Pages: Document Model Data Annotations - Work Item 877

我正在尝试记录我的响应模型：

以及各个字段/属性

我已经尝试过混合使用 XML cmets、DataMember 和 Display 属性，但似乎都没有。

/// <summary>
/// blah blah blah
/// </summary>
[DataContract(Name = "Application")]
public class Application
{
    /// <summary>
    /// Please Display!
    /// </summary>
    [DataMember(Order = 0)]
    [Display(Description="Please Display!")]
    [StringLength(11, MinimumLength = 11)]
    public string ApplicationId { get; set; }

这是我的 Areas/HelpPage/App_Start/HelpPageConfig.cs 中的示例

namespace WebAPI.Areas.HelpPage
{
    #pragma warning disable 1591
    /// <summary>
    /// Use this class to customize the Help Page.
    /// For example you can set a custom <see cref="System.Web.Http.Description.IDocumentationProvider"/> to supply the documentation
    /// or you can provide the samples for the requests/responses.
    /// </summary>
    public static class HelpPageConfig
    {
        public static void Register(HttpConfiguration config)
        {
            // remove unwanted formatters
            config.Formatters.Clear();
            var jsonsettings = new JsonSerializerSettings() { DateParseHandling = DateParseHandling.None };
            config.Formatters.Add(new JsonMediaTypeFormatter());
            config.Formatters.Add(new XmlMediaTypeFormatter());
            config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/bin/WebAPI.XML")));
            // create sample objects
            config.SetSampleObjects(new Dictionary<Type, object>
            {
                { typeof(MyResponse), new MyResponse() { 
                    Message = "Key d795677d-6477-494f-80c5-874b318cc020 is not recognised", 
                    Code = ResponseCode.InvalidKey, Id = null }
                }
            });             
            //*** More Sample Requests ***
        }
    }
    #pragma warning restore 1591
}

10/06/2014 更新：我的类定义存储在单独的库中。我注意到这里存在差异。主 API 和类定义库正在生成单独的 XML 文件。

API 项目

定义项目

我试图通过将定义写入同一个 XML 项目来纠正这个问题。但是这不起作用，并且没有添加类定义条目。

Answer 1

要在描述部分显示内容，您需要感受 XML cmets 部分。如果您将模型类放置在您的 webapi 项目中 - 那么这将是一个解决方案。您的问题是您需要一次读取 2 个 xml 文件的 xml 文档，而 XmlDocumentationProvider 不支持。我的建议是创建您自己的 MultipleFilesXmlDocumentationProvider ，只需像这样：

public class MultipleFilesXmlDocumentationProvider : IDocumentationProvider
{
    IEnumerable<XmlDocumentationProvider> xmlDocumentationProviders;

    public MultipleFilesXmlDocumentationProvider(IEnumerable<string> documentPaths)
    {
        xmlDocumentationProviders = documentPaths.Select(path => new XmlDocumentationProvider(path));
    }

    public string GetDocumentation(HttpParameterDescriptor parameterDescriptor)
    {
        foreach(XmlDocumentationProvider provider in xmlDocumentationProviders)
        {
            string documentation = provider.GetDocumentation(parameterDescriptor);
            if(documentation != null)
                return documentation;
        }
        return null;
    }

    public string GetDocumentation(HttpActionDescriptor actionDescriptor)
    {
        foreach (XmlDocumentationProvider provider in xmlDocumentationProviders)
        {
            string documentation = provider.GetDocumentation(actionDescriptor);
            if (documentation != null)
                return documentation;
        }
        return null;
    }

    public string GetDocumentation(HttpControllerDescriptor controllerDescriptor)
    {
        foreach (XmlDocumentationProvider provider in xmlDocumentationProviders)
        {
            string documentation = provider.GetDocumentation(controllerDescriptor);
            if (documentation != null)
                return documentation;
        }
        return null;
    }

    public string GetResponseDocumentation(HttpActionDescriptor actionDescriptor)
    {
        foreach (XmlDocumentationProvider provider in xmlDocumentationProviders)
        {
            string documentation = provider.GetDocumentation(actionDescriptor);
            if (documentation != null)
                return documentation;
        }
        return null;
    }
}

这将只是 XmlDocumentationProvider 的包装器 - 它将与 XmlDocumentationProvider 的集合一起使用，并查找第一个将提供所需文档的集合。然后在 HelpPageConfig 中更改配置以使用 MultipleFilesXmlDocumentationProvider：

config.SetDocumentationProvider(
    new MultipleFilesXmlDocumentationProvider(
        new string[] { 
            HttpContext.Current.Server.MapPath("~/bin/WebAPI.XML"), 
            HttpContext.Current.Server.MapPath("~/bin/EntityModel.Definitions.XML")
        }
    )
 );

当然要考虑到上面的配置，两个 XML 文件都应该在 WebAPI 项目的 bin 文件夹中。