Язык программирования C#9 и платформа .NET5

 [HttpGet("one")]
 public IEnumerable<string> Get1
 {
  return new string[] { "value1", "value2" };
 }
 [HttpGet("two")]
 public ActionResult<IEnumerable<string>> Get2
 {
  return new string[] { "value1", "value2" };
 }
 [HttpGet("three")]
 public string[] Get3
 {
  return new string[] { "value1", "value2" };
 }
 [HttpGet("four")]
 public IActionResult Get4
 {
  return new JsonResult(new string[] { "value1", "value2" });
 }

Чтобы протестировать код, запустите приложение AutoLot.Api; вы увидите список всех методов из ValuesController в пользовательском интерфейсе (рис. 30.1).

Вспомните, что при определении маршрутов суффикс Controller отбрасывается из имен маршрутов, поэтому конечные точки в ValuesController сопоставляются с Values, а не с ValuesController.

Для выполнения одного из методов щелкните на кнопке GET, на кнопке Try it out (Опробовать) и на кнопке Execute (Выполнить). После выполнения метода пользовательский интерфейс обновится, чтобы отобразить результаты; наиболее важная часть пользовательского интерфейса Swagger показана на рис. 30.2.

Вы увидите, что выполнение каждого метода приводит к получению тех же самых результатов JSON.

Атрибут ApiController

Атрибут ApiController, появившийся в версии ASP.NET Core 2.1, в сочетании с классом ControllerBase обеспечивает правила, соглашения и линии поведения, специфичные для REST. Соглашения и линии поведения рассматриваются в последующих разделах.

Обязательность маршрутизации с помощью атрибутов

При наличии атрибута ApiController контроллер обязан использовать маршрутизацию с помощью атрибутов. Это просто принудительное применение того, что многие расценивают как установившуюся практику.

Автоматические ответы с кодом состояния 400

Если есть проблема с привязкой модели, то действие будет автоматически возвращать код состояния HTTP 400 (Bad Request), что заменяет следующий код:

 if (!ModelState.IsValid)
 {
  return BadRequest(ModelState);
 }

Для выполнения показанной выше проверки инфраструктура ASP.NET Core использует фильтр действий ModelStatelnvalidFilter. При наличии ошибок привязки или проверки достоверности ответ HTTP 400 в своем теле содержит детальные сведения об ошибках. Вот пример:

 {
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "traceId": "|7fb5e16a-4c8f23bbfc974667.",
  "errors": {
  "": [
  "A non-empty request body is required."
  ]
  }
 }

Такое поведение можно отключить через конфигурацию в методе ConfigureServices класса Startup:

 services.AddControllers
  .ConfigureApiBehaviorOptions(options =>
  {
  options.SuppressModelStateInvalidFilter = true;
  });

Выведение источников для привязки параметров

Механизм привязки моделей будет логически выводить источники извлечения значений на основе соглашений, описанных в табл. 30.1.

Такое поведение можно отключить через конфигурацию в методе Configure Services класса Startup:

 services.AddControllers.ConfigureApiBehaviorOptions(options =>
 {
   // Подавить все выведение источников для привязки.
   options.SuppressInferBindingSourcesForParameters= true;
   // Подавить выведение типа содержимого multipart/form-data.
   options. SuppressConsumesConstraintForFormFileParameters = true;
 });

Детальные сведения о проблемах для кодов состояния ошибок

ASP.NET Core трансформирует результат ошибки (состояние 400 или выше) в результат с помощью типа ProblemDetails, который показан ниже:

 public class ProblemDetails
 {
  public string Type { get; set; }
  public string Title { get; set; }
  public int? Status { get; set; }
  public string Detail { get; set; }
  public string Instance { get; set; }
  public IDictionary<string, object> Extensions { get; }
  = new Dictionary<string, object>(StringComparer.Ordinal);