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

所属分类: 网络编程 / ASP.NET 阅读数: 1774
收藏 0 赞 0 分享

业务场景:

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

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。

更多精彩内容其他人还在看

Asp.net中的mail的发送

Asp.net中的mail的发送
收藏 0 赞 0 分享

用ASP.Net实现文件的在线压缩和解压缩

用ASP.Net实现文件的在线压缩和解压缩
收藏 0 赞 0 分享

ASP.NET中文件上传下载方法集合

ASP.NET中文件上传下载方法集合
收藏 0 赞 0 分享

ASP.NET通过Remoting service上传文件

ASP.NET通过Remoting service上传文件
收藏 0 赞 0 分享

ASP.NET2.0服务器控件之Render方法

ASP.NET2.0服务器控件之Render方法
收藏 0 赞 0 分享

ASP.NET2.0 WebRource,开发微调按钮控件

ASP.NET2.0 WebRource,开发微调按钮控件
收藏 0 赞 0 分享

ASP.NET2.0新特性概述

ASP.NET2.0新特性概述
收藏 0 赞 0 分享

介绍几个ASP.NET中容易忽略但却很重要的方法函数

介绍几个ASP.NET中容易忽略但却很重要的方法函数
收藏 0 赞 0 分享

asp.net2.0如何加密数据库联接字符串

asp.net2.0如何加密数据库联接字符串
收藏 0 赞 0 分享

用.NET 2.0压缩/解压功能处理大型数据

用.NET 2.0压缩/解压功能处理大型数据
收藏 0 赞 0 分享
查看更多