Блог

У нас есть приложение, для которого требуется наличие некоторых полей. Если эти поля отсутствуют, мы вернем ответ 400, объясняющий, чего не хватает в соответствующем сообщении об ошибке. Кажется, добавление APIM в микс сильно усложняет его. Поскольку APIM знают, что поле является обязательным, похоже, что оно сократит curcuit и вернет 404 с общим сообщением вместо нашего самоочевидного сообщения о том, что не так.

Это способ отключить эту функциональность для APIM?

Я получаю ту же проблему, и в конечном итоге меняю свой подход. Что я сделал, так это настроил его на стороне приложения и использовал 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 свойствами.

Теперь включите FluentValidation в качестве механизма проверки по умолчанию для нашего приложения, добавив следующий код в ConfigureServices метод Startup.cs file:

 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 не должен замыкать запрос, вызывая 404 Not Found его при попытке доступа /api/foo/{id} .

Причина, по которой это работает, заключается в том, что Swashbuckle автоматически не импортирует правила проверки из FluentValidation. Это означает, что свойства PropertyA и PropertyB не будут помечены как требуемые при их просмотре в пользовательском интерфейсе Swagger. Это недостаток этого подхода, поскольку требуемые параметры строки запроса из пользовательского интерфейса Swagger не будут помечены как требуемые, что может сбить с толку потребителей. Но для меня важнее вернуть правильный код состояния с содержательным сообщением потребителям, и именно поэтому я пока буду придерживаться этого обходного пути. Вы могли бы попробовать использовать параметр MicroElements.Swashbuckle.FluentValidation to altleastустановить / пометить параметры, как требуется в схеме пользовательского интерфейса Swagger. Но это только об этом.

Я писал об этом в блоге здесь: грязный взлом при создании требуемых параметров строки запроса для работы в Azure APIM

В разделе надстройки политики API / продукта / глобального уровня -ошибка, используйте выбрать политику, чтобы проверить, была ли найдена операция или нет:

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