自定义API响应数据注释

Question

我目前正在构建一个 Web API，当 DataAnnotation Validation 出现错误时，我在显示响应时遇到问题

这是代码：

public class NewPatient
{
  [StringLength(13)]
  [Required(ErrorMessage = "Format Nomor Kartu Tidak Sesuai")]
  public string nomorkartu { get; set; }
  
  [StringLength(16)]
  [Required(ErrorMessage = "Format NIK Tidak Sesuai")]
  public string nik { get; set; }
}

当验证运行时，上面的验证返回如下响应：

{
  "errors": {
    "nomorkartu": [
      "Format Nomor Kartu Tidak Sesuai."
    ]
  },
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "traceId": "00-5dc8a15c7bf9dfe1e99d3312fbfe16f7-368da3671328539c-00"
}

如何显示格式就像下面的回复：

{
  "metadata":{
    "code":"400",
    "message": "Format Nomor Kartu Tidak Sesuai."
  }
}

谢谢

Answer 1

您可以通过在启动中添加以下代码来做到这一点。

public class NewPatient
{
  [StringLength(13)]
  [Required(ErrorMessage = "Format Nomor Kartu Tidak Sesuai")]
  public string nomorkartu { get; set; }
  
  [StringLength(16)]
  [Required(ErrorMessage = "Format NIK Tidak Sesuai")]
  public string nik { get; set; }
}

在启动中添加代码

// 添加模型验证错误的自定义响应

services.AddMvcCore().ConfigureApiBehaviorOptions(options => {
            options.InvalidModelStateResponseFactory = (errorContext) =>
            {
                var errors = errorContext.ModelState.Values.SelectMany(e => e.Errors.Select(m => new
                {
                    ErrorMessage = m.ErrorMessage
                })).ToList();
                var result = new
                {
                    Metadata = new
                    {
                        Code = (int)HttpStatusCode.BadRequest,
                        Message = errors.Select(e => e.ErrorMessage).ToList()
                    }
                };
                return new BadRequestObjectResult(result);
            };
        });