Язык программирования C#9 и платформа .NET5 - Эндрю Троелсен
// Должно обрабатываться более элегантно.
return new BadRequestObjectResult(ex.GetBaseException()?.Message);
}
return Ok();
}
Метод начинается с определения маршрута как запроса HttpDelete с обязательным параметром маршрута id. Значение id в маршруте сравнивается со значением id, отправленным с остальной частью сущности в теле запроса, и если они не совпадают, то возвращается код 400 (Bad Request). Если хранилище успешно удаляет запись, тогда клиенту возвращается код 200 (ОК), а если возникла какая-то ошибка, то клиент получает код 400 (Bad Request).
На этом создание базового контроллера завершено.
Класс CarsController
Приложению AutoLot.Api необходим дополнительный метод HttpGet для получения записей Car на основе значения Make. Он будет создан в новом классе по имени CarsController. Создайте в каталоге Controllers новый пустой контроллер API под названием CarsController. Модифицируйте операторы using следующим образом:
using System.Collections.Generic;
using AutoLot.Api.Controllers.Base;
using Microsoft.AspNetCore.Mvc;
using AutoLot.Models.Entities;
using AutoLot.Dal.Repos.Interfaces;
using AutoLot.Services.Logging;
using Microsoft.AspNetCore.Http;
using Swashbuckle.AspNetCore.Annotations;
Класс CarsController является производным от класса BaseCrudController и определяет маршрут на уровне контроллера. Конструктор принимает специфичное для сущности хранилище и средство ведения журнала. Вот первоначальный код контроллера:
namespace AutoLot.Api.Controllers
{
[Route("api/[controller]")]
public class CarsController : BaseCrudController<Car, CarsController>
{
public CarsController(ICarRepo carRepo, IAppLogging<CarsController> logger) :
base(carRepo, logger)
{
}
}
}
Класс CarsController расширяет базовый класс еще одним методом действия, который получает все записи об автомобилях конкретного производителя. Добавьте показанный ниже код:
/// <summary>
/// Gets all cars by make
/// </summary>
/// <returns>All cars for a make</returns>
/// <param name="id">Primary key of the make</param>
/// <response code="200">Returns all cars by make</response>
[Produces("application/json")]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status204NoContent)]
[SwaggerResponse(200, "The execution was successful")]
[SwaggerResponse(204, "No content")]
[HttpGet("bymake/{id?}")]
public ActionResult<IEnumerable<Car>> GetCarsByMake(int? id)
{
if (id.HasValue && id.Value>0)
{
return Ok(((ICarRepo)MainRepo).GetAllBy(id.Value));
}
return Ok(MainRepo.GetAllIgnoreQueryFilters());
}
Атрибут HttpGet расширяет маршрут константой bymake и необязательным идентификатором производителя для фильтрации, например:
https://localhost:5021/api/cars/bymake/5
Сначала в методе проверяется, было ли передано значение для id. Если нет, то получаются все автомобили. Если значение было передано, тогда с использованием метода GetAllBy() класса CarRepo получаются автомобили по производителю. Поскольку защищенное свойство MainRepo базового класса определено с типом IRepo<T>, его потребуется привести к типу ICarRepo.
Оставшиеся контроллеры
Все оставшиеся контроллеры, специфичные для сущностей, будут производными от класса BaseCrudController, но без добавления дополнительной функциональности. Добавьте в каталог Controllers еще четыре пустых контроллера API с именами CreditRisksController, CustomersController, MakesController и OrdersController.
Вот код оставшихся контроллеров:
// CreditRisksController.cs
using AutoLot.Api.Controllers.Base;
using AutoLot.Models.Entities;
using AutoLot.Dal.Repos.Interfaces;
using AutoLot.Services.Logging;
using Microsoft.AspNetCore.Mvc;
namespace AutoLot.Api.Controllers
{
[Route("api/[controller]")]
public class CreditRisksController
: BaseCrudController<CreditRisk, CreditRisksController>
{
public CreditRisksController(
ICreditRiskRepo creditRiskRepo, IAppLogging<CreditRisksController> logger)
: base(creditRiskRepo, logger)
{
}
}
}
// CustomersController.cs
using AutoLot.Api.Controllers.Base;
using AutoLot.Models.Entities;
using AutoLot.Dal.Repos.Interfaces;
using AutoLot.Services.Logging;
using Microsoft.AspNetCore.Mvc;
namespace AutoLot.Api.Controllers
{
[Route("api/[controller]")]
public class CustomersController : BaseCrudController<Customer, CustomersController>
{
public CustomersController(
ICustomerRepo customerRepo, IAppLogging<CustomersController> logger)
: base(customerRepo, logger)
{
}
}
}
// MakesController.cs
using AutoLot.Api.Controllers.Base;
using AutoLot.Models.Entities;
using Microsoft.AspNetCore.Mvc;
using AutoLot.Dal.Repos.Interfaces;
using AutoLot.Services.Logging;
namespace AutoLot.Api.Controllers
{
[Route("api/[controller]")]
public class MakesController : BaseCrudController<Make, MakesController>
{
public MakesController(IMakeRepo makeRepo, IAppLogging<MakesController> logger)
: base(makeRepo, logger)
{
}
}
}
// OrdersController.cs
using AutoLot.Api.Controllers.Base;
using AutoLot.Dal.Repos.Interfaces;
using AutoLot.Models.Entities;
using AutoLot.Services.Logging;
using Microsoft.AspNetCore.Mvc;
namespace AutoLot.Api.Controllers
{
[Route("api/[controller]")]
public class OrdersController : BaseCrudController<Order, OrdersController>
{
public OrdersController(IOrderRepo orderRepo,
IAppLogging<OrdersController> logger) : base(orderRepo, logger)
{
}
}
}
Итак, все контроллеры готовы и вы можете с помощью пользовательского интерфейса Swagger протестировать полную функциональность. Если вы собираетесь добавлять/обновлять/удалять записи, тогда измените значение RebuildDataBase на true в файле appsettings.development.json:
{
...
"RebuildDataBase": true,
...
}
Фильтры исключений
Когда в приложении Web API возникает исключение, никакая страница со сведениями об ошибке не отображается, т.к. пользователем обычно является другое приложение, а не человек. Информация об ошибке должна быть отправлена в формате JSON наряду с кодом состояния HTTP. Как обсуждалось в главе 29, инфраструктура ASP.NET Core позволяет создавать фильтры, которые запускаются при появлении необработанных исключений. Фильтры можно применять глобально, на уровне контроллера или на уровне действия. Для текущего приложения вы построите фильтр исключений для отправки данных JSON (вместе с кодом HTTP 500) и включения трассировки стека, если сайт функционирует в режиме отладки.
На заметку! Фильтры — крайне мощное средство ASP.NET Core. В этой главе вы ознакомитесь только с фильтрами исключений, но с их помощью можно создавать очень многое, что значительно экономит время при построении приложений ASP.NET Core. Полную информацию о фильтрах ищите в документации по ссылке https://docs.microsoft.com/ru-ru/aspnet/core/mvc/controllers/filters.
Создание специального фильтра исключений
Создайте новый каталог под названием Filters и добавьте в него новый файл класса по имени CustomExceptionFilterAttribute.cs. Приведите операторы using к следующему виду:
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Filters;
using Microsoft.EntityFrameworkCore;
using Microsoft.Extensions.Hosting;
Сделайте класс открытым и унаследованным от ЕхсерtionFiIterAttribute. Переопределите метод OnException(), как показано ниже:
namespace AutoLot.Api.Filters
