模型绑定失败时的自定义响应 ASP.NET Core API

Question

当模型绑定到API因数据类型不匹配而失败时，我想给出一个自定义响应。

示例：当有人尝试在我的 API 中将 string 绑定到 GUID 参数时，目前我得到以下响应。

    {
      "documentCategoryId": [
        "Error converting value \"string\" to type 'System.Guid'. Path 'documentCategoryId', line 2, position 32."
      ]
    }

相反，我想说，

处理错误

Answer 1

尝试使用FormatOutput 方法自定义 BadRequest 响应，如下所示：

 services.AddMvc()
         .ConfigureApiBehaviorOptions(options =>
            {
                options.InvalidModelStateResponseFactory = actionContext =>
                {
                    return new BadRequestObjectResult(FormatOutput(actionContext.ModelState));
                };
            });

随心所欲地自定义 FormatOutput 方法。

public List<Base> FormatOutput(ModelStateDictionary input)
    {
        List<Base> baseResult = new List<Base>();
        foreach (var modelStateKey in input.Keys)
        {
            var modelStateVal = input[modelStateKey];
            foreach (ModelError error in modelStateVal.Errors)
            {
                Base basedata = new Base();
                basedata.Status = StatusCodes.Status400BadRequest;
                basedata.Field = modelStateKey; 
                basedata.Message =error.ErrorMessage; // set the message you want 
                baseResult.Add(basedata);
            }
        }
        return baseResult;
    }

 public class Base
{
    public int Status { get; set; }
    public string Field { get; set; }
    public string Message { get; set; }
}

Answer 2

参考此post，要根据您的用例添加自定义响应，请在启动

中添加以下代码

services.Configure<ApiBehaviorOptions>(o =>
{
    o.InvalidModelStateResponseFactory = actionContext =>
        new ResponseObject("403", "processing error");
});

ResponseObject 是一个自定义类

 class ResponseObject{
   public string Status;
   public string Message;
   ResponseObject(string Status, string Message){
     this.Status = Status;
     this.Message= Message;
   }
 }

当模型绑定失败时，api 会返回这样的响应

{ 状态：“403”，消息：“处理错误”}

您可以随意自定义响应对象。