Question

我正在设置ProducesResponseType，以便将其记录在Swagger中。

如果响应成功（OK => 200），则会产生IEnumerable。

[ProducesResponseType(typeof(IEnumerable<MyModel>), 200)]

但是当我得到异常时，我会抓住它，然后生成我的自定义APIError类的对象。当我填充对象时，我可以设置不同的HttpStatusCodes，但最后，我想要的是能够设置ProducesResponseType是我所有剩余HttpStatusCodes的APIError类。我的意思是，我可以得到BadRequest，ServerInternalError，Forbidden等，但所有都会有相同的响应类型（ApiError）。有没有办法为所有错误http代码设置这行代码？或者我需要逐个设置它？

[ProducesResponseType(typeof(ApiError), ???)]

最终结果应如下所示：

[ProducesResponseType(typeof(IEnumerable<MyModel>), 200)]
[ProducesResponseType(typeof(ApiError), AllFailureHttpCodes)]

Answer 1

我担心这是不可能的，至少不是每次行动。

IApiResponseMetadataProvider（请参阅here）只定义了一个int StatusCode { get; }属性，并且它同时用于ProducesAttribute和ProducesResponseTypeAttribute。

但是，在您的特殊情况下，您可以将其注册为全局过滤器，因为无论是GET，POST，PUT还是DELETE，所有操作的错误结果都应相同。

services.AddMvc(options =>
{
    options.Filters.Add(new Microsoft.AspNetCore.Mvc.ProducesResponseTypeAttribute(typeof(ApiError), 400));
    options.Filters.Add(new Microsoft.AspNetCore.Mvc.ProducesResponseTypeAttribute(typeof(ApiError), 401));
    options.Filters.Add(new Microsoft.AspNetCore.Mvc.ProducesResponseTypeAttribute(typeof(ApiError), 409));
});

然后应将这些应用于MVC / WebAPI应用程序中的每个操作。

警告词

然而，我个人认为这种用法不对，因为它会表示您的每个方法都可以处理这些类型的错误。例如409专门用于冲突，在您使用它的WebAPI中，当更新资源时出现错误，即使用乐观并发时，记录被另一个用户更改，因此记录的版本发生了更改，更新失败。

将这些添加到每个方法都是错误的。如果您的操作确实处理了此状态代码，则只应添加状态代码。例如，409仅适用于PUT和POST方法。其中404可能适合GET和PUT（更新），但不太适合POST（插入）。

这尤其糟糕，当您使用Swagger等工具生成Api文档时，您将获得错误的文档。您应该将ProducesResponseType视为文档形式，因此，不应该使用过于通用的方法。

为几个HttpStatusCodes设置一个ProducesResponseType typeof

1 个答案:

警告词