缺少必填字段时，是否可以强制 Azure API 管理返回 400 而不是 404？

Question

我们有一个应用程序需要提供一些字段。如果这些字段不存在，我们将返回 400 响应，解释正确的错误消息中缺少的内容。将 APIM 添加到混合中似乎会使它复杂化很多。由于 APIM 知道该字段是必需的，因此它看起来会缩短 curcuit 并返回 404 并带有通用消息，而不是我们自我解释的错误消息。

这是为 APIM 关闭此功能的一种方式吗？

Answer 1

我遇到了同样的问题，我最终改变了我的方法。我所做的是在应用程序端对其进行配置，并使用 FluentValidation 使查询字符串参数成为必需。所以，我的模型现在看起来像这样：

using FluentValidation;

public class UrlQueryParameters
{
    public string PropertyA { get; set; }
    public string PropertyB { get; set; }
}

public class UrlQueryParametersValidator : AbstractValidator<UrlQueryParameters>
{
    public UrlQueryParametersValidator()
    {
        RuleFor(o => o.PropertyA)
            .NotEmpty()
            .WithMessage("The 'PropertyA' parameter was missing or a value was not provided.");

        RuleFor(o => o.PropertyB)
            .NotEmpty()
            .WithMessage("The 'PropertyB' parameter was missing or a value was not provided.");
    }
}

前面的代码为PropertyA 和PropertyB 属性定义了一些带有自定义消息的验证规则。

现在，通过在Startup.cs 文件的ConfigureServices 方法中添加以下代码，启用 FluentValidation 作为我们应用程序的默认验证机制：

public void ConfigureServices(IServiceCollection services) {
    // Rest of the code omitted for brevity
    
    services
      .AddControllers()
      .AddFluentValidation(fv => 
      { 
          fv.DisableDataAnnotationsValidation = true;
          
          // The following line registers ALL public validators in the assembly containing UrlQueryParametersValidator
          // There is no need to register additional validators from this assembly.
          fv.RegisterValidatorsFromAssemblyContaining<UrlQueryParametersValidator>(lifetime: ServiceLifetime.Singleton);
      });
}

此时，您的 API 端点应验证请求中的所需参数，并且 APIM 不应在您尝试访问 /api/foo/{id} 时通过抛出 404 Not Found 来缩短请求。

之所以可行，是因为 Swashbuckle 不会自动从 FluentValidation 导入验证规则。这意味着，在 Swagger UI 中查看属性 PropertyA 和 PropertyB 时，它们不会被标记为必需。这是这种方法的缺点，因为来自 Swagger UI 的必需查询字符串参数不会被标记为必需，这可能会让消费者感到困惑。但对我来说，向消费者返回带有有意义信息的正确 StatusCode 更为重要，这就是我暂时坚持这种解决方法的原因。您可以尝试使用 MicroElements.Swashbuckle.FluentValidation 在 Swagger UI 架构中根据需要至少设置/标记参数。但仅此而已。

我在这里写了一篇博客：Dirty Hack on Making the Required QueryString Params to Work in Azure APIM

Answer 2

在 API/产品/全局级别策略添加 on-error 部分，使用选择策略检查是否找到操作：

<choose>
  <when condition="@(context.LastError.Source == "configuration" && context.LastError.Reason == "OperationNotFound")">
    <return-response>
      <set-status code="400" reason="Bad Request" />
    </return-response>
  </when>
</choose>