Добавить подробное сообщение в ASP. NET Стандарт Core 3.1 JSON Ответ BadRequest

Question

У меня в приложении ASP. NET Core 3.1 есть контроллер, который в одном из случаев возвращает BadRequest(). По умолчанию он выдает ответ json:

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "Bad Request",
  "status": 400,
  "traceId": "|492dbc28-4cf485d536d40917."
}

Что замечательно, но я хотел бы добавить строковое значение detail с сообщением c.

Когда я возвращаю BadRequest("msg"), ответ представляет собой простой текст msg.

Когда я делаю это таким образом BadRequest(new { Detail = "msg" }), ответ будет json:

{
  "detail": "msg"
}

Что лучше, но я хотел бы также сохранить исходные данные json.

Моя цель - вернуть такой ответ:

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "Bad Request",
  "detail": "msg",
  "status": 400,
  "traceId": "|492dbc28-4cf485d536d40917."
}

Есть ли способ свершилось sh это?

Answer 1

Метод ControllerBase.Problem идеально подходит для этого. Вот пример, который дает желаемый ответ:

public IActionResult Post()
{
    // ...

    return Problem("msg", statusCode: (int)HttpStatusCode.BadRequest);
}

Вот пример вывода, для полноты:

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "Bad Request",
  "status": 400,
  "detail": "msg",
  "traceId": "|670244a-4707fe3038da8462."
}

Answer 2

Получить данные Json в типизированном объекте и отправить этот ответ обратно.

class MyClass
{
    public string type { get; set; }
    public string title { get; set; }
    public string status { get; set; }
    public string traceId { get; set; }
    public string detail { get; set; }
}

Преобразуйте ваши данные Json с помощью этого класса Type и добавьте подробное сообщение в поле detail.

var obj = JsonConvert.DeserializeObject<MyClass>(yourJson);
obj.detail = "msg";