请求响应对象和内容类型注释约定

Question

我正在使用 asp.net core 2.2.6，我不清楚关于使用ProducesAttribute和ProducesResponseTypeAttribute注释与ProblemDetails的预期约定是什么。如果没有注释，API 会按预期运行，并且内容类型会应用于适当的返回类型，但是当使用注释来辅助 Swashbuckle 时，该行为是有限制的。

例如，考虑以下内容：

[HttpPut]
[Consumes("application/json")]
[Produces("application/json", "application/problem+json")]
// [Produces("application/json", Type = typeof(ProblemDetails))]
[ProducesResponseType(StatusCodes.Status204NoContent)]
[ProducesResponseType(StatusCodes.Status400BadRequest)]
[ProducesResponseType(StatusCodes.Status403Forbidden)]
[ProducesResponseType(StatusCodes.Status500InternalServerError)]
public async Task<IActionResult> Put([FromBody] SomeModel model, CancellationToken cancellationToken)
{
    // ...
}

当发生错误并ProblemDetails返回实例时，会覆盖默认处理并将返回类型设置为“application/json”。

该Produces属性可以关联单个对象和内容类型，但它不允许您定义多个实例。解决方案是使用几个ProducesResponseType属性来声明一个类型（尽管它是正确推断的并且不是必需的），但是这个属性不利于内容类型（如在 source 中声明的那样）。

根据ObjectResultExecutor，行为是明确的。

默认情况下，swagger-ui 甚至没有将“应用程序/问题+json”内容类型显示为可用的内容类型之一，因此无法在操作过滤器中过滤媒体类型（您可以获取第一个ProblemDetails引用并重建具有新内容类型键的集合）。

什么是 Swashbuckle 最优雅的解决方案，它不会在 api 中引入不良行为，但会限制 swagger ui 以显示所需的内容类型？