Swagger 中的 ServiceStack API 文档-UI 闭门造车

Question

我只想允许访问 swagger-ui 和元数据，只有当用户在我们的网络应用程序上经过身份验证（表单身份验证）时，但我想一直允许 API 访问（API 有一些 public 方法和一些需要 ui 基本身份验证的方法。

所以我所做的是为 API 添加了这个路由前缀：

public override RouteAttribute[] GetRouteAttributes(Type requestType)
{
    var routes = base.GetRouteAttributes(requestType);
    routes.Each(x => x.Path = "/API" + x.Path);
    return routes;
}

并且：

ServiceRoutes = new Dictionary<Type, string[]> {
{
         typeof(AuthenticateService), new[] { "/api/auth", "/api/auth/{provider}" }
     },
}

Web 配置中也是如此：

<location path="api">
<system.web>
  <authorization>
    <allow users="*"/>
  </authorization>
</system.web>

问题是，当我现在转到 /api/ 时工作正常，但是当我尝试调用某些方法时，我被重定向到我的 login 路由。

有没有办法像我开始的那样解决这个问题，或者有更好的方法来保护文档？

Answer 1

没有明确的选项要求对元数据页面进行身份验证，但您可以使用 PreRequestFilter 来保护对 /metadata 和 /swagger-ui 页面的访问：

PreRequestFilters.Add((req, res) =>
{
    if (req.PathInfo.StartsWith("/metadata") || req.PathInfo.StartsWith("/swagger-ui"))
    {
        var session = req.GetSession();
        if (!session.IsAuthenticated)
        {
            res.StatusCode = (int)HttpStatusCode.Unauthorized;
            res.EndRequest();
        }
    }
});

并且为了保护对 /openapi JSON 规范的访问，如果您正在使用 Swagger 2.0 / Open API Feature，您可以在运行时动态添加 [Authenticate] 属性：

public AppHost()
{
    typeof(OpenApiService)
        .AddAttributes(new AuthenticateAttribute());
}

如果您使用的是旧版 Swagger 1.2 Plugin，您可以通过以下方式保护对后端服务的访问：

public AppHost()
{
    typeof(SwaggerResource)
        .AddAttributes(new AuthenticateAttribute());
    typeof(SwaggerResources)
        .AddAttributes(new AuthenticateAttribute());
}

这假设您使用的是 ServiceStack Authentication 而不是 ASP.NET Auth.

Swagger 中的 ServiceStack API 文档-UI 闭门造车

ServiceStack API documentation in Swagger-UI behind the closed doors

c#

servicestack

forms-authentication