ASP.NET Core WebApi 返回統一格式參數 - xishuai－IT工程師數位筆記本

文章出處

業務場景：

業務需求要求，需要對 WebApi 接口服務統一返回參數，也就是把實際的結果用一定的格式包裹起來，比如下面格式：

{
    "response":{
        "code":200,
        "msg":"Remote service error",
        "result":""
    }
}

具體實現：

using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Filters;

public class WebApiResultMiddleware : ActionFilterAttribute
{
    public override void OnResultExecuting(ResultExecutingContext context)
    {
        //根據實際需求進行具體實現
        if (context.Result is ObjectResult)
        {
            var objectResult = context.Result as ObjectResult;
            if (objectResult.Value == null)
            {
                context.Result = new ObjectResult(new { code = 404, sub_msg = "未找到資源", msg = "" });
            }
            else
            {
                context.Result = new ObjectResult(new { code = 200, msg = "", result = objectResult.Value });
            }
        }
        else if (context.Result is EmptyResult)
        {
            context.Result = new ObjectResult(new { code = 404, sub_msg = "未找到資源", msg = "" });
        }
        else if (context.Result is ContentResult)
        {
            context.Result = new ObjectResult(new { code = 200, msg = "", result= (context.Result as ContentResult).Content });
        }
        else if (context.Result is StatusCodeResult)
        {
            context.Result = new ObjectResult(new { code = (context.Result as StatusCodeResult).StatusCode, sub_msg = "", msg = "" });
        }
    }
}

Startup添加對應配置：

public void ConfigureServices(IServiceCollection services)
{
    services.AddMvc(options =>
    {
        options.Filters.Add(typeof(WebApiResultMiddleware));
        options.RespectBrowserAcceptHeader = true;
    });
}