【问题标题】:Empty model property description on ASP.NET Web API Help PagesASP.NET Web API 帮助页面上的空模型属性描述
【发布时间】:2016-07-23 06:45:07
【问题描述】:

简介

我已关注 this tutorial 设置我的 ASP.NET Web API 帮助页面。

使用<package id="Microsoft.AspNet.WebApi.HelpPage" version="5.2.3" targetFramework="net452" />

文档似乎很好,但我得到了空模型属性描述

它们在控制器方法/端点和模型详细信息文档中都是空的。

控制器方法示例

/// <summary>
/// POST: api/remitent
/// </summary>
/// <param name="remitent"></param>
public void Post([FromBody]Remitent remitent)
{

}

模型属性示例

/// <summary>
/// First name property summary
/// </summary>
[Required]
[MaxLength(49)]     
public string FirstName { get; set; }

结果

我希望 FirstName 属性摘要能够填充文档上的模型属性描述。相反,描述列是空的:


有人知道怎么解决吗?

【问题讨论】:

  • 我也有同样的问题,你找到解决办法了吗?
  • @bit 不幸的是我没有。
  • 遇到了同样的问题。如果您查看生成的 xml 文件,则没有关于模型的信息。
  • @MaximilianoEjberowicz 看到这个问题的答案:stackoverflow.com/questions/30562235/…
  • @foresightyj 它有效!模型和 Web API 在不同的项目中。

标签: asp.net-web-api asp.net-web-api2 asp.net-web-api-helppages


【解决方案1】:

您是否取消了 Areas/HelpPage/App_Start/HelpPageConfig.cs 中这行代码的注释:

config.SetDocumentationProvider(new XmlDocumentationProvider(
    HttpContext.Current.Server.MapPath("~/App_Data/XmlDocument.xml")));

【讨论】:

  • 是的,我按照教程中提到的所有步骤进行操作。
【解决方案2】:

你能用 Swashbuckle 代替 Microsoft.AspNet.WebApi.HelpPage。我发现 Swashbuckle 提供了更好的文档和友好的 UI 来探索你的 API。您也可以使用它来测试您的 API。

【讨论】:

  • 我很欣赏swashbuckle 替代方案,似乎有很多功能。我什至在其他项目中使用 swagger 文档。我会考虑未来,但首先想解决web api帮助问题。
猜你喜欢
  • 1970-01-01
  • 1970-01-01
  • 2015-10-06
  • 2019-12-25
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2013-09-07
相关资源
最近更新 更多