详解ASP.NET Core WebApi 返回统一格式参数

2019-10-27 12:20:51

字体：大中小

来源：转载

供稿：网友

业务场景：

业务需求要求，需要对 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;  });}

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持CuoXin错新网。

注：相关教程知识阅读请移步到ASP.NET教程频道。

上一篇：ASP.NET 页生命周期概述(小结)

下一篇：利用Builder方式创建对象示例代码