问题标签 [asp.net-web-api-helppages]

我从 NuGet 安装了软件包，取消了 HelpPageConfig.cs- 中的注释行

我在 Properties->Build->XML 文档文件下设置了相同的文件，添加了一个新的 Global.asax.cs 文件，我在其中调用 Application_Start 方法下的所有区域进行注册：

我为我的一些控制器添加了一些摘要：

当我运行网页并转到“/帮助”时，我唯一看到的是

ASP.NET Web API 帮助页面

介绍

在此处提供您的 API 的一般描述。

然后是一个空白页面......

我试图调试它并在 HelpController.cs 中：

我没有 ApiDescriptions。

我错过了什么？我将不胜感激任何帮助！

我有基本的 API 控制器：

和刚刚从基础继承方法 GetByYear 的孩子：

我使用帮助页面来创建自动文档。结果我得到：

我想了解这两种方法的描述。
如何在不覆盖的情况下获取子类中方法 GET 的 XML 注释？
或者我应该把它复制到我的孩子班吗？

当我<inheritdoc />在 HouseController 中使用时，我得到与上面相同的结果，并且我不想在不需要时覆盖每个方法：

另一个问题：如何在默认帮助页面中使用 ghostdoc？

当我运行我的程序时，它只显示“在此处提供您的 API 的一般描述”。但没有显示内容。就像这张图片：http: //i.stack.imgur.com/unBmb.png

我的问题类似于这个ASP.NET Web Api 帮助页面没有显示任何提示，但它没有提供任何解决方案。

我已按照“将帮助页面添加到现有项目”中的本教程http://www.asp.net/web-api/overview/getting-started-with-aspnet-web-api/creating-api-help-pages一切都是从 nuGet 自动创建的，除了“ValuesController”。

我猜这就是问题所在。

我的价值观控制器：

有没有人对此有解决方案，或者对可能出错的地方有任何建议？

（我还创建了一个新的 asp.net web api-project （其中包含从一开始的 valuescontroller），这工作正常..）

我有一个对象，它的参数是整数列表。为了让这个对象与 Entity Framework 表现得很好并保存在 SQL 中，我有一个计算属性来序列化该字符串。

这工作得非常好，并且正是我想要它做的事情，因为数据库存储了序列化版本，我可以使用代码中的整数列表。序列化的字符串将只包含整数，所以没有问题..

..API 文档生成器除外。我正在使用 Microsoft.AspNet.WebApi.HelpPage 从代码文档中自动生成帮助页面内容。不知何故，出于某种原因，这是试图插入“示例字符串 3”作为 ObjParametersSerialized 的值 - 这显然不起作用并引发错误。

它作为一个值也没有任何意义，但我理解它为什么这样做，因为它只是看到一个 typeOf(string)。

如何自定义或覆盖 HelpPage 生成器以提供合理的值？

我正在使用 azure 部署我的新 Web API，我是在 IIS 和 azure 上部署的新手。

我已经在 azure 上将我的 Web API 添加为 Web 应用程序，它运行良好，直到我为每个 API 的函数添加了文档。添加描述后，我从 HelpPageConfig.cs 取消注释下面的行。

它在本地运行，我可以看到所有描述，但是当我在 azure 上发布它时，我收到错误消息，

网站网址： http: //mejodo.azurewebsites.net/

我需要改变路径吗？

文件已在我的系统中的 D:\home\site\wwwroot\App_Data 目录中创建。

我需要做哪些更改才能使其正常工作？

我刚开始使用 ASP.NET 5。我想为我的方法创建一个帮助页面，我看到了一些创建帮助页面的示例，但其中大多数都是特定于 MVC 的。我已经浏览了Microsoft.AspNet.WebApi.HelpPage包，它为帮助页面创建了一个区域，但我没有使用 MVC 模式。

除此区域方法外，我如何创建帮助页面有什么建议吗？

我正在开发一个 Web-API 项目，我对 Microsoft 的 HelpPages 自动生成的文档印象深刻。

我使用创建帮助页面的官方网站启用了自定义文档

<See cref="">文档已成功生成，但似乎没有将标签中对类的引用添加到描述中，HelpPages 只是忽略它们（这是有原因的）。

我真的很想在我的项目中拥有这个功能，我搜索了很多（有时很接近）但没有一个给出令人信服的答案。

这就是为什么我决定将我的解决方案发布到这个调整中，并希望能够使其他程序员受益，并为他们节省一些时间和精力。（我的答案在下面的回复中）

我已经配置了 Web API 帮助页面文档。

我有下面的类，它将在其他模型类中继承。

我不希望 IsRejected 被序列化并作为响应可用，因此我使用 IgnoreDataMember 属性对其进行了修饰。

继承 ResponseBase 的模型类示例。

我在我的 Web API 控制器中有以下方法：

现在对于读取对象列表的请求参数的文档，它将列出读取的所有属性以及 ResponseBase 类（继承）。我希望帮助页面文档将 ErrorReason 列为仅响应中的参数之一。

[ApiExplorerSettings(IgnoreApi = true)]除了在 ErrorReason 上设置属性之外，我还能做任何配置吗？如果我这样做，ErrorReason 在请求和响应参数中都将不可用。我只想在响应参数列表中显示它。

我有一个WebApi带有帮助区的服务。出于安全原因，我需要将此MVC帮助区域移动到MVC同一解决方案中的另一个项目。

怎样才能做到这一点？

我知道API信息是通过XML文件获取的，但只是移动区域和XML文件？

我使用 REST 端点增强了旧的 SOAP 样式 Web 服务。大多数一切都正常工作，但我无法弄清楚如何更改自动生成的帮助文件的介绍。我现在所拥有的是将介绍显示为“在此处提供您的 API 的一般描述”。

我已经关注了这个类似的问题，但没有解释在哪里更改介绍并记录了其他所有内容，但仍然不知道在哪里更改介绍。

我应该使用第 2 版的 Web-API。