.NET Core Web API：返回内容类型为 application/problem+json 的自定义 HTTP 状态代码

Question

ControllerBase 包含诸如 Conflict() 之类的方法，这些方法返回从 StatusCodeResult 派生的 ConflictResult 对象（表示 HTTP 409 响应）。生成的响应正文的内容类型为 application/problem+json，如下所示：

{
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.8",
    "title": "Conflict",
    "status": 409,
    "traceId": "0HLO99QHFC9QI:00000001"
}

没有用于 HTTP 410 响应的内置方法/类，所以我做了一个：

[DefaultStatusCode(410)]
public class GoneResult : StatusCodeResult
{
    public GoneResult() : base(410)
    {}
}
...
public static class ControllerBaseExtensions
{
    public static GoneResult Gone(this ControllerBase controllerBase) // this doesn't give all the problem+JSON attributes
    {
        return new GoneResult();
    }
}

然而，这给了

{
    "type": "about:blank",
    "status": 410
}

即，type 值不同，title 和 traceId 字段丢失。

我还想为 HTTP 500 响应创建一个自定义类，其中包含带有错误消息的 message 字段。我尝试返回StatusCode(StatusCodes.Status500InternalServerError)，这给了我与Gone() 方法相同的最小application/problem+json 响应；我也尝试过返回StatusCode(StatusCodes.Status500InternalServerError, message)，这给了我错误消息，但将响应格式化为text/plain。

Answer 1

生成ProblemDetails 响应的代码不知道410 状态码，因此它没有关联的Link 和Title 属性在构建响应对象时使用。要添加这种感知，请在ConfigureServices 中配置ApiBehaviorOptions，如下所示：

services.Configure<ApiBehaviorOptions>(options =>
{
    options.ClientErrorMapping[410] = new ClientErrorData
    {
        Title = "Gone",
        Link = "https://tools.ietf.org/html/rfc7231#section-6.5.9"
    };
});

ClientErrorMapping 是int（状态码）到ClientErrorData 的字典。请注意，我在上面用于 Link 的值确实指向了 RFC 的正确部分。

Answer 2

简单地说，您必须实际返回一个ProblemDetails 响应正文。我必须深入研究代码才能确定，但​​我认为 ASP.NET Core 通过中间件执行此操作只是为了特定结果。他们说 4xx 范围内的任何内容，但我认为这实际上仅限于返回该范围内状态代码的内置结果类型，而不是任何 4xx 的结果状态码。同样，这是猜想，因为我还没有看到他们在做什么，尽管它不是作为实际结果类的一部分发生的。

出于您的目的，您可以通过几种不同的方式来处理此问题。您可以编写自己的中间件来捕获出站响应并重写它们。您可以使用自定义异常处理程序。您可以简单地从ObjectResult 继承，然后自己创建一个ProblemDetails 实例并将其放入基础中。您甚至可以直接从您的操作中返回 ProblemDetails（不过，这显然是最不理想的方式）。