使用新的webapi 2.1位。由于某些原因,当我打开帮助页面时,不会显示任何属性的描述详细信息,例如

/// <summary>
/// Some summary that shows correct
/// </summary>
[DataContract]
public class MyClass
{

    /// <summary>
    /// Display something.....
    /// </summary>
    [DataMember(Name = "Great")]
    public string MyGreatProperty { get; set; }

当我打开帮助页面时,我可以看到摘要“一些显示正确的摘要”,但是对于此模型的属性,没有任何摘要显示。

webapi 2是否不支持对属性的描述?

最佳答案

感谢您的详细信息。我不确定是否可以在Web API中称其为bug,因为它并不固有地依赖于xml文件进行文档编制。例如,如果您安装了HelpPage,则会在XmlDocumentationProvider.cs下注意到一个名为Areas\HelpPage的文件。
提供程序的此实现着眼于单个xml文件。

对于您的方案,您可以创建IDocumentationProviderIModelDocumentationProvider的自定义实现,其中基于C#类型,您可以查看不同的xml文档文件。您可以在默认的XmlDocumentationProvider中重用大多数代码。

关于asp.net-mvc - 不同组件中的 Controller 或模型时的HelpPage XML文档,我们在Stack Overflow上找到一个类似的问题:https://stackoverflow.com/questions/21393754/

10-12 20:07