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

Метод проверяет, совпадает ли значение маршрута (id) со значением id в теле запроса. Если не совпадает, то возвращается код 400 (Bad Request). Если совпадает, тогда используется хранилище для обновления записи. Если обновление терпит неудачу с генерацией исключения, то клиенту возвращается код 400 (Bad Request). Если операция обновления проходит успешно, тогда клиенту возвращается код 200 (ОК) и обновленная запись в качестве тела запроса.

На заметку! Обработка исключений в этом примере (а также в остальных примерах) абсолютно неадекватна. В производственных приложениях вы должны задействовать все знания, полученные к настоящему времени, чтобы элегантно обрабатывать возникающие проблемы в соответствии с имеющимися требованиями.

Метод AddOne

Вставка записи делается с применением HTTP-метода POST. Ниже приведен код метода AddOne:

///

/// Adds a single record

///

///

/// Sample body:

///

/// {

///   "Id": 1,

///   "TimeStamp": "AAAAAAAAB+E="

///   "MakeId": 1,

///   "Color": "Black",

///   "PetName": "Zippy",

///   "MakeColor": "VW (Black)",

/// }

///

///

/// Added record

/// Found and updated the record

/// Bad request

[Produces("application/json")]

[ProducesResponseType(StatusCodes.Status201Created)]

[ProducesResponseType(StatusCodes.Status400BadRequest)]

[SwaggerResponse(201, "The execution was successful")]

[SwaggerResponse(400, "The request was invalid")]

[HttpPost]

public ActionResult AddOne(T entity)

{

  try

  {

    MainRepo.Add(entity);

  }

  catch (Exception ex)

  {

    return BadRequest(ex);

  }

  return CreatedAtAction(nameof(GetOne), new {id = entity.Id}, entity);

}

Метод начинается с определения маршрута как запроса HttpPost. Параметр маршрута отсутствует, потому что создается новая запись. Если хранилище успешно добавит запись, то ответом будет результат вызова метода CreatedAtAction, который возвращает клиенту код 201 вместе с URL для вновь созданной сущности в виде значения заголовка Location. Вновь созданная сущность в формате JSON помещается внутрь тела ответа.

Метод DeleteOne

Удаление записи делается с применением HTTP-метода DELETE. Ниже приведен код метода DeleteOne:

///

/// Deletes a single record

///

///

/// Sample body:

///

/// {

///   "Id": 1,

///   "TimeStamp": "AAAAAAAAB+E="

/// }

///

///

/// Nothing

/// Found and deleted the record

/// Bad request

[Produces("application/json")]

[ProducesResponseType(StatusCodes.Status200OK)]

[ProducesResponseType(StatusCodes.Status400BadRequest)]

[SwaggerResponse(200, "The execution was successful")]

[SwaggerResponse(400, "The request was invalid")]

[HttpDelete("{id}")]

public ActionResult DeleteOne(int id, T entity)

{

  if (id != entity.Id)

  {

    return BadRequest;

  }

  try

  {

    MainRepo.Delete(entity);

  }

  catch (Exception ex)

  {

    // Должно обрабатываться более элегантно.

    return new BadRequestObjectResult(ex.GetBaseException?.Message);

  }

  return Ok;

}

Метод начинается с определения маршрута как запроса HttpDelete с обязательным параметром маршрута id. Значение id в маршруте сравнивается со значением id, отправленным с остальной частью сущности в теле запроса, и если они не совпадают, то возвращается код 400 (Bad Request). Если хранилище успешно удаляет запись, тогда клиенту возвращается код 200 (ОК), а если возникла какая-то ошибка, то клиент получает код 400 (Bad Request).

На этом создание базового контроллера завершено.

Класс CarsController