在 Web API 路由（和子端点）上强制 404

Question

我正在寻找一种简单的方法来对 Web API 中给定路由的所有请求以及该路由中的所有端点返回 404 错误。在我的场景中，我将有一个配置标志来打开和关闭它。它是一个使用 Swagger/Swashbuckle 的文档端点，并且希望能够将其打开和关闭作为各种功能切换。

<add key="EnableDocumentation" value="true|false" />

理想情况下，对于以 /swagger 开头的所有路由（包括 /swagger/ui/index.html），如果上述值为 false

，我想返回 404

我在 HttpConfiguration.Routes 中尝试了 IgnoreRoute，但这不适用于比指定级别更深的路由。如果我忽略/swagger，仍然可以访问/swagger/ui/index.html

有什么好的方法可以做到这一点吗？

谢谢！

Answer 1

您可以通过编写自己的自定义 HTTP 模块来做到这一点。

在您的 HTTP 模块中，您可以检查传入的 url 请求，如果 url 与您的路由匹配，则返回 404。

查看这些（只是为了了解如何编写自定义 http 模块）

• Writing your 1st HttpModule in ASP.NET under 2 minutes
• An IP Address Blocking HttpModule for ASP.NET in 9 minutes

Answer 2

我有一个类似的场景：

1. 我想为 API 文档安装 Swashbuckle
2. 我想在不删除 Nuget 包或重新部署 API 的情况下控制对 Swagger 的访问

这导致我得到以下代码：

public class SwaggerConfig
{
    private const string AllowSwaggerUsageAppSetting = "AllowSwaggerAccess";

    public static void Register()
    {
        if (AllowSwaggerAccess)
        {
            Swashbuckle.Bootstrapper.Init(GlobalConfiguration.Configuration);
        }

        // NOTE: If you want to customize the generated swagger or UI, use SwaggerSpecConfig and/or SwaggerUiConfig here ...
    }

    private static bool AllowSwaggerAccess
    {
        get
        {
            bool _parsedValue;

            return bool.TryParse(ConfigurationManager.AppSettings[AllowSwaggerUsageAppSetting] ?? "false", out _parsedValue) && _parsedValue;
        }
    }
}

除非 web.config 的 appSettings 部分中有一个名为 AllowSwaggerAccess 且 Bool.Parse'able 值为 true 的键>，Swashbuckle 引导程序被忽略，这意味着无法访问 swagger 文档，并且对 API 的请求返回 404。

以上代码基于 Swashbuckle Nuget Package v4。

如果你从 github 下载代码，你可以看到 Init 方法负责设置路由：

public static class Bootstrapper
{
    public static void Init(HttpConfiguration config)
    {
        config.Routes.MapHttpRoute(
            "swagger_root",
            "swagger",
            null,
            null,
            new RedirectHandler("swagger/ui/index.html"));

        config.Routes.MapHttpRoute(
            "swagger_ui",
            "swagger/ui/{*uiPath}",
            null,
            new { uiPath = @".+" },
            new SwaggerUiHandler());

        config.Routes.MapHttpRoute(
            "swagger_versioned_api_docs",
            "swagger/{apiVersion}/api-docs/{resourceName}",
            new { resourceName = RouteParameter.Optional },
            null,
            new SwaggerSpecHandler());

        config.Routes.MapHttpRoute(
            "swagger_api_docs",
            "swagger/api-docs/{resourceName}",
            new { resourceName = RouteParameter.Optional },
            null,
            new SwaggerSpecHandler());
    }
}