我设置了我的 Web API 控制器 我的帮助页面正常工作 但我不希望某些 API 控制器显示在帮助页面中
如何阻止 API 控制器出现在帮助页面中?
干杯
我设置了我的 Web API 控制器 我的帮助页面正常工作 但我不希望某些 API 控制器显示在帮助页面中
如何阻止 API 控制器出现在帮助页面中?
干杯
您可以在类之前或控制方法之前使用以下内容。
using System.Web.Http.Description;
//you have to use above namespace to use the code below.
[ApiExplorerSettings(IgnoreApi = true)]
如果你在类之前使用它,整个控制器类将被忽略。因此,您将找不到特定控制器的标题。
如果您在控制器方法之前使用它,那么只有该控制器将被忽略并且不会显示在帮助页面上。
您可以使用以下属性和设置来装饰控制器:
[ApiExplorerSettings(IgnoreApi = true)]
如果您想禁用所有控制器(通常我们有很多控制器),请创建一个新控制器作为这些控制器的基础。
/// <summary>
/// Base api controller for all controllers
/// </summary>
[ApiExplorerSettings(IgnoreApi = true)]
public class BaseApiController : ApiController
{...
然后将新的基本控制器作为当前控制器的父级。
public class MyController: BaseController
帮助页面将禁用所有控制器