c# - 有关复杂类型的文档描述

在我的API中，我试图记录不同的字段描述，但是属性似乎都不起作用。我知道应该已经在WebAPI 5.1(运行WebAPI.HelpPage 5.1.2)中实现了此功能。

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

我正在尝试记录我的两个响应模型:

以及各个字段/属性

我尝试过混合使用XML注释，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项目来纠正此问题。但是，这不起作用，并且不会添加类定义条目。

最佳答案

要在“描述”部分中显示内容，您需要感受一下XML注释部分。如果您将模型类放在webapi项目中-那么这将是一个解决方案。您的问题是您需要阅读xml文档形式的2个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文件夹中。