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

我有 ASP.NET Web API 项目，我想添加一个帮助页面，但我希望它位于一个单独的项目中。

可能吗 ？

* Scenario: *

I have got a web api service application made in C# Visual Studio 2012. This web service has an "Areas" folder with the default project of Web Api Help Page.

* Problem: *

By requeriment, I must to implement a manual input to authenthicate and authorize the user that can read the Web Api Help Page. But NOT in the web service.

So far so good, I've made an account controller, log in procedures, get roles from the database, etc etc.
But now, what I try to realize is how to write the Application_PostAuthenticateRequest procedure in the global.asax, because the only global.asax that I've is from the main project, the Web API Help Page has not his own.

* QUESTION *
How can I write the Application_PostAuthenticateRequest method without impacting on the main service, in order to use the Authorization attributes ONLY in the Web API Help Page?

Thanks and kind regards,

我在我的Web API 帮助页面中收到重复的条目，其中包含不同的父项，例如这些引用相同的方法：

GET api/{apiVersion}/v1/Products - 获取所有产品

...

GET api/v1/Products - 获取所有产品

...

我有一个带有如下路由的 Web API 页面：

我曾认为此路由将使“v1”成为可选，因此不需要上面的派生文档。

（侧边栏：去api/products肯定行不通，所以我不确定这有什么问题。我错过了什么？）

似乎真正的问题是 Web API 帮助页面不正确地读取了路由，正如我所想的那样v1，{apiVersion} 它们不应该出现在同一个动作中。 我在这里想念什么？

我有一个 C# .Net 4.5 Web Api 应用程序，我已向其中添加了一个帮助页面，例如此处显示的那个。

当开发人员在 Visual Studio 中启动 Web Api 应用程序时，我希望出现帮助页面。

我想通过使用路由（例如更改 WebApiConfig.cs 或 Global.asax.cs）而不是项目属性中的设置来实现这一点。

在 WebApiConfig.cs 文件中，我尝试添加以下内容 -

那没有用。有谁知道如何使这项工作？谢谢。

我正在尝试使用Microsoft ASP.NET Web API 2.2 Help Page 5.2.3为 RESTful Web 服务构建 API 文档。看起来<summary>和<param>元素的内容包含在文档中，但该<remarks>部分完全被忽略了，在我期望的描述中<returns>，我看到了<summary>. 我找不到任何文章解释帮助页面支持哪些 XML 注释标签（或者注释控制器与注释常规代码有何不同）。我想知道是否有人可以分享任何指针，特别是可以使用哪些标签，如何引用其他页面等。

我正在使用 Web API 2，它似乎已经调用了我现有的 API 调用，除了它复制了我拥有的每个区域的所有调用。例如，假设我有 3 个区域，其中一个区域有一个 API 调用，如下所示：

如果我有 3 个区域，那么 web api 帮助页面将显示：

获取 area1/api/MyAPIController/GetStringList/{id}

获取 area2/api/MyAPIController/GetStringList/{id}

获取 area3/api/MyAPIController/GetStringList/{id}

并且 MyAPIController 仅存在于“area2”中。为什么会显示 3 次，我该如何解决？如果有帮助，我对 area2 的区域注册是：

假设我在一个解决方案中有两个项目

• WebApi：一个WebApi项目，为所有api服务提供接入点
• Core：此处定义业务逻辑的库项目，包括系统模型。

对于每个 WebApi 请求，它使用 ModelState 检查模型是否有效，然后将请求传递给 Core 库中定义的业务模型以获取结果。

我想拥有自动 API 文档，因此我将 WebApi 项目配置为生成 XML 文档，HelpPage 模块按预期完美运行，除了在 Core.dll 中定义的模型时，它是空白的。

我想知道是否有任何解决方法可以使 HelpPage 模块“识别”WebApi 项目之外的 XML 文档？

我正在处理一个需要 API 帮助页面上的文档的项目。该页面已创建，可以插入信息。但我有一些问题：

1. 我对此很陌生，所以我在浏览项目时遇到了一些问题。

2. 我想引用直接在 Controller 文件中的 XML 注释，如下所示：

   /li>

WebApiConfig.cs 文件中的 HTTP 路由代码如下所示：

但是，我不知道如何在网络帮助页面上发表评论。我见过很多使用参数 ID 的示例，但似乎没有 ID，而且我不知道如何找到或制作参数 ID，因为帮助页面显示除了 ID 之外的所有内容。例如，我应该创建一个XMLDocument.xml文件并将所有评论都放在那里吗？

有没有办法为使用属性生成 web api 帮助页面提供示例？我知道我可以通过转到 /Areas/HelpPage/... 来提供示例，但我希望它们与我的代码一起放在一个地方。

这些方面的东西：

我正在使用 ASP.NET Web API，它可以方便地自动为我的 API 生成文档，但其中一些没有意义。

以下面的截图为例。

这是GET用户 ID 的端点，在该Resource Description部分中它显示了一个表格，该表格显示了用户模型的属性，因为我的控制器操作具有[ResponseType(typeof(User))]注释。

首先，在我的实际控制器操作中，我在Password向用户显示结果之前剥离了属性，以免暴露敏感信息。所以该Resource Description部分中给出的表格是不正确的，它说我的 API 返回了它没有返回的字段。

其次，在该列下，它显示了与模型Additional Information一起使用的验证规则。User很方便，但在这种情况下根本不相关，因为这个端点是给GET用户的，而不是给一个用户的POST。

所以，我的问题是如何自定义此Resource Description表以指定自己返回哪些字段并隐藏 EF 验证？

我目前已经这样评论了我的控制器操作：

并且我已将帮助页面配置为从///构建项目时从这些注释构建的 XML 文件中读取文档。

谢谢！