网络核心API：ProducesResponseType的用途

Question

我想了解ProducesResponseType.

的目的

Microsoft定义为a filter that specifies the type of the value and status code returned by the action.

所以我很好奇

会带来什么后果

• 一个人没有放置ProductResponseType吗？
• 系统处于不利状态还是会带来负面后果？
• Microsoft API是否不是已经自动固有地返回了状态码的已知类型/值？

[ProducesResponseType(typeof(DepartmentDto), StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status404NotFound)]

Microsoft提供的文档：ProducesResponseTypeAttribute Class

Answer 1

它用于为 API 探索/可视化工具（例如 Swagger (https://swagger.io/)）生成开放 API 元数据，以在文档中指明控制器可能返回的内容。

Answer 2

我认为对于不成功（200）的返回码它可以派上用场。 假设如果故障状态代码之一返回描述问题的模型，则可以指定在这种情况下状态代码产生的结果与成功情况不同。 您可以阅读有关此内容的更多信息，并在此处找到示例：https://docs.microsoft.com/en-us/aspnet/core/web-api/action-return-types?view=aspnetcore-2.2