记录复杂类型的描述

Question

在我的API中,我试图记录不同的字段描述,但是没有一个属性似乎有效.我知道这个功能应该是最近在WebAPI 5.1中运行的(运行WebAPI.HelpPage 5.1.2).

ASP.Net Web API帮助页面:文档模型数据注释 - 工作项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
}

2014年10月10日更新:我的类定义存储在一个单独的库中.我注意到这里存在差异.主API和类定义库生成单独的XML文件.

API项目

定义项目

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

Answer 1

要在描述部分显示内容，您需要感受 XML 注释部分。如果您将模型类放置在 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 的集合一起使用，并查找第一个提供所需文档的 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 文件夹中。