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

我开发了一个 WebAPI 服务，它为每个控制器（全局）传递请求和响应标头。WebAPI HelpController 是否通过 HttpResponseMessage 和 Requests 支持这些文档？

示例请求标头；

内容类型：应用程序/xml；字符集=utf-8

示例响应标头；

X-Rate-Limit-Remaining：1000

X-Rate-Limit-Limit: 1000

我有一些由 EF 从 Oracle 数据库中生成的类。这些类将用于使用Help Pages构建一个宁静的 Web API 。我想知道如何为这些生成的类的属性添加注释。我可以编辑那些生成的类文件，但如果我必须重新映射它们，它们就会消失。

我尝试为生成的类创建 DTO 类并使用AutoMapper，但这很快就失控了，因为我有很多类要为其创建 DTO，更糟糕的是派生类最终会有两个属性，这使得帮助页面不是很有帮助。

我希望 C# 能让我重新定义类的属性，但我知道这是不可能的，我想知道向生成的类添加注释最不痛苦的方法是什么。

为了使用 Web API 帮助页面为我的 Web API 项目生成 XML 文档，我必须检查项目属性的“构建”部分下的“XML 文档文件”选项。当我在本地构建时，这会正确生成文档。

但是，当我签入时，我在构建服务器上收到以下错误：

CSC：生成 XML 文档文件时出错'c:\Builds\3...\Sources\CurrentVersion...\ProjectName\App_Data\XmlDocument.xml'（'访问被拒绝。'）

我不确定为什么会发生这种情况，因为它无论如何都会为每个构建创建一个新目录。我搜索了这个问题并搜索了 Stack Overflow，但我发现的唯一解决方案是删除 XML 文档文件（这违背了使用 Web API 帮助页面的目的）。我该如何解决这个问题？

在我的 API 中，我试图记录不同的字段描述，但是似乎没有一个属性起作用。我知道这个功能应该是最近在 WebAPI 5.1 中实现的（运行 WebAPI.HelpPage 5.1.2）。

ASP.Net Web API 帮助页面：文档模型数据注释 - 工作项 877

我正在尝试记录我的响应模型：

以及各个字段/属性

我尝试了 XML 注释、DataMember 和 Display 属性的混合，但似乎没有一个被选中。

这是我的 Areas/HelpPage/App_Start/HelpPageConfig.cs 中的示例

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

API项目

定义项目

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

我在 VS 2010 中使用较旧的 WCF 框架开发了许多内部 REST 接口。它生成帮助页面的能力对于 DEV 和 QA 平台很方便，但对于生产版本，很容易禁用这些帮助页面的生成在web.config文件中：

我现在转而使用 WebAPI 框架（目前是 VS 2012 上的版本 1），但关闭此功能似乎并不容易（即我无法找到有关如何执行此操作的任何信息web.config 文件）。

当然，我可以继续在代码本身中手动执行此操作，但肯定有更简单的方法；类似于上面描述的 WCF 是如何做到的。我想使用 web.config 文件方法，因为我已经为其他设置准备了 web.release.config 转换文件。

对此最佳实践的任何想法将不胜感激。

在我的源代码文档中，我经常使用：

这很好地转换为 XmlDocument.xml 中的以下字符串，其中包含已编译的 Web api 帮助页面。

但由于某些原因，所有这些引用都没有显示。我们得到的是这样的：

我们找到了一些来源，但似乎没有任何效果。没有帮助：
Web Api 帮助页面 - 不要在 xml 文档中转义 html

过时的： http:
//thesoftwaredudeblog.wordpress.com/2014/01/04/using-microsoft-asp-net-web-api-2-help-page-part-2/

有任何想法吗？

我有一个关于 ASP.NET Web API HelpPages 的问题。

通常 HelpPages 可以通过 XMLDocumentation 示例代码生成 WebAPI：

这样就可以成功生成了，像这样：

但如果我使用通用基本控制器，它不会生成 API 文档。

样本：

如果我使用第二部分的代码，HelpPages 可以生成 API 文档，但不会生成 API 注释。我的两个示例之间的区别只是第二部分代码使用了泛型类型。

在该方法Do()中，与第一个相比，注释不显示

有没有解决这些问题的方法？

是否可以从WebAPI Help Pages为 WebAPI 项目创建 DTD 或 XSD 文件。我正在使用 WebAPI 帮助页面来记录请求和响应模型，但我是在生成更正式的定义文档之后。

早上好，

我有一个由两个项目组成的解决方案。一个是类库，包含将在其他项目中使用的通用类。另一个是 WebAPI 2.1 项目。

我正在使用自动帮助页面生成器为 API 生成帮助文件，但我注意到当它引用 Common 项目中的类时，它不使用摘要。

有没有办法让它做到这一点？我在网上搜索过，但找不到任何解决方案。我也尝试在 Common 项目中安装帮助页面生成器，但无济于事。

我有一个返回模板类的 ASP.NET Web API，但我无法获取 Web API 帮助页面来正确提供返回类型的文档。

假设我有以下模型类：

我的 API 操作如下所示

生成的 Web API 帮助页面随后声明 Get 操作返回 aMyTypeOfFoo并且不提供 MyType 的 XML 文档，它仅列出它包含的参数。可能是因为它不明白那MyTypeOfFoo是一样的MyType<Foo>。这个问题有什么已知的解决方案吗？

更新

创建一个伪类并返回它也不起作用。例如

上述代码的文档输出缺少可用于继承属性的注释。