时间戳

首页 > 解决方案 > 在 Swagger 上指定可能的错误代码 - DotNet Web API

.net-core - 在 Swagger 上指定可能的错误代码 - DotNet Web API

问题描述

我正在使用带有 web api 的 dotnet core 5.0，当发生一些错误时，我们返回一个像这样的对象：

{
  "error": {
    "status": 500,
    "message": {
      "code": "internalerror",
      "description": "Some description here.."
    },
    "errors": []
  }
}

这error.message.code是我们在前端用来显示更好信息的代码。在控制器方法上，我们使用一些注释来描述可能的状态代码：

[HttpPatch("api/v1/users")]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(typeof(ErrorResult), StatusCodes.Status400BadRequest)]
[ProducesResponseType(typeof(ErrorResult), StatusCodes.Status500InternalServerError)]
public async Task<IActionResult> UpdateUserConfigurationsAsync(UpdateUserConfigurationsData data)

基于此，有没有办法映射端点的所有特定错误代码？我尝试使用 Swagger 示例，但效果不佳。

标签： .net-coreswaggerswagger-ui

解决方案

推荐阅读