自定义 Web API 响应，如状态、数据、消息格式

Question

如何以 JSON 格式自定义 WebAPI 2 响应，如状态、数据、消息

请求成功：

{
  "status": "success",
  "data": {
    /* Application-specific data would go here. */
  },
  "message": null /* Or optional success message */
}

请求失败：

{
  "status": "error",
  "data": null, /* or optional error payload */
  "message": "Error xyz has occurred"
}

Answer 1

定义一个新的 class 如：

public class ResponseDto
{
    public string status { get; set; }

    public dynamic data { get; set; }

    public string message { get; set; }
}

然后用相应的值填充属性并执行：

var response = new ResponseDto()
{
    response.status = " ",
    response.data = obj,
    response.message = " "
}

然后从控制器方法(API),

return response;

您的 JSON 格式化程序随后会将响应对象转换为 JSON 字符串。

Customise WebAPI response like Status, Data, message formate