Mvc4 Web API - 关闭特定Controller的帮助页面

Question

我已经设置了Web API控制器 我有帮助页面工作 但我不希望某些API控制器显示在帮助页面中

如何停止出现在帮助页面中的API控制器？

干杯

Answer 1

您可以在课前或控制方法之前使用以下内容。

 using System.Web.Http.Description;
 //you have to use above namespace to use the code below.
 [ApiExplorerSettings(IgnoreApi = true)]

如果在类之前使用它，则将忽略整个控制器类。因此，您将找不到特定控制器的标题。

如果在控制器方法之前使用它，那么只有那个控制器会被忽略而不会显示在帮助页面上。

Answer 2

您可以使用以下属性和设置来装饰控制器：

[ApiExplorerSettings(IgnoreApi = true)]

Answer 3

如果要禁用所有控制器（通常我们有很多控制器），请创建一个新控制器作为这些控制器的基础。

/// <summary>
/// Base api controller for all controllers
/// </summary>
[ApiExplorerSettings(IgnoreApi = true)]
public class BaseApiController : ApiController
{...

然后将新的基本控制器作为当前控制器的父级。

public class MyController: BaseController

所有控制器都将被禁用以获取帮助页面