ASP.NETWebAPIOwnResponseCodePatternSuggestion”如何实现自定义响应码及返回信息?
创始人
2024-09-19 13:31:25
0

在实际开发中,经常需要自定义 API 返回的响应码及消息,以方便前端或其它调用方对接收到的响应有更全面的理解。ASP.NET Web API 提供了一种简单的方式来实现这种自定义响应模式。

  1. 首先,我们需要创建一个继承自 IHttpActionResult 接口的自定义 Result 类,例如下面的代码:

    public class CustomResult : IHttpActionResult { private string _message; private HttpStatusCode _statusCode;

     public CustomResult(string message, HttpStatusCode statusCode = HttpStatusCode.OK)
     {
         _message = message;
         _statusCode = statusCode;
     }
    
     public Task ExecuteAsync(CancellationToken cancellationToken)
     {
         var response = new HttpResponseMessage(_statusCode);
         response.Content = new StringContent(_message);
         return Task.FromResult(response);
     }
    

    }

  2. 接着,我们就可以在我们的 API 方法中使用这个自定义 Result 类,例如下面的代码:

    [HttpGet] public IHttpActionResult Get() { var message = "Hello World!"; return new CustomResult(message, HttpStatusCode.OK); }

  3. 最后,在客户端调用 API 的时候,就可以根据返回的响应码来判断是否成功,同时通过 response.Content.ReadAsStringAsync().Result 获取到返回的消息,例如下面的代码:

    var response = await client.GetAsync("api/values"); if (response.IsSuccessStatusCode) { var message = await response.Content.ReadAsStringAsync(); Console.WriteLine(message); } else { Console.WriteLine("Error: " + response.StatusCode); }

通过这种方式,我们就可以方便地实现 ASP.NET Web API 的自定义响应码及返回信息,以满足不同场景的需要。

相关内容

热门资讯

iwatch怎么连接安卓系统,... 你有没有想过,那款时尚又实用的iWatch,竟然只能和iPhone好上好?别急,今天就来给你揭秘,怎...
iphone系统与安卓系统更新... 最近是不是你也遇到了这样的烦恼?手机更新系统总是失败,急得你团团转。别急,今天就来给你揭秘为什么iP...
安卓系统怎么连不上carlif... 安卓系统无法连接CarLife的原因及解决方法随着智能手机的普及,CarLife这一车载互联功能为驾...
安卓换鸿蒙系统会卡吗,体验流畅... 最近手机圈可是热闹非凡呢!不少安卓用户都在议论纷纷,说鸿蒙系统要来啦!那么,安卓手机换上鸿蒙系统后,...
oppo手机安卓系统换成苹果系... OPPO手机安卓系统换成苹果系统:现实吗?如何操作?随着智能手机市场的不断发展,用户对于手机系统的需...
安卓平板改windows 系统... 你有没有想过,你的安卓平板电脑是不是也能变身成Windows系统的超级英雄呢?想象在同一个设备上,你...
安卓系统上滑按键,便捷生活与高... 你有没有发现,现在手机屏幕越来越大,操作起来却越来越方便了呢?这都得归功于安卓系统上的那些神奇的上滑...
安卓系统连接耳机模式,蓝牙、有... 亲爱的手机控们,你们有没有遇到过这种情况:手机突然变成了“耳机模式”,明明耳机没插,声音却只从耳机孔...
安卓系统拦截短信在哪,安卓系统... 你是不是也遇到了这种情况:手机里突然冒出了很多垃圾短信,烦不胜烦?别急,今天就来教你怎么在安卓系统里...
windows官网系统多少钱 Windows官网系统价格一览:了解正版Windows的购买成本Windows 11官方价格解析微软...