Fork me on GitHub

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

业务场景:

业务需求要求,需要对 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;
    });
}
posted @   田园里的蟋蟀  阅读(12731)  评论(11编辑  收藏  举报
编辑推荐:
· 10年+ .NET Coder 心语,封装的思维:从隐藏、稳定开始理解其本质意义
· .NET Core 中如何实现缓存的预热?
· 从 HTTP 原因短语缺失研究 HTTP/2 和 HTTP/3 的设计差异
· AI与.NET技术实操系列:向量存储与相似性搜索在 .NET 中的实现
· 基于Microsoft.Extensions.AI核心库实现RAG应用
阅读排行:
· 10年+ .NET Coder 心语 ── 封装的思维:从隐藏、稳定开始理解其本质意义
· 地球OL攻略 —— 某应届生求职总结
· 提示词工程——AI应用必不可少的技术
· Open-Sora 2.0 重磅开源!
· 周边上新:园子的第一款马克杯温暖上架
点击右上角即可分享
微信分享提示