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 的自定义响应码及返回信息,以满足不同场景的需要。

相关内容

热门资讯

安卓换鸿蒙系统会卡吗,体验流畅... 最近手机圈可是热闹非凡呢!不少安卓用户都在议论纷纷,说鸿蒙系统要来啦!那么,安卓手机换上鸿蒙系统后,...
app安卓系统登录不了,解锁登... 最近是不是你也遇到了这样的烦恼:手机里那个心爱的APP,突然就登录不上了?别急,让我来帮你一步步排查...
安卓系统拦截短信在哪,安卓系统... 你是不是也遇到了这种情况:手机里突然冒出了很多垃圾短信,烦不胜烦?别急,今天就来教你怎么在安卓系统里...
安卓系统要维护多久,安卓系统维... 你有没有想过,你的安卓手机里那个陪伴你度过了无数日夜的安卓系统,它究竟要陪伴你多久呢?这个问题,估计...
windows官网系统多少钱 Windows官网系统价格一览:了解正版Windows的购买成本Windows 11官方价格解析微软...
安卓系统如何卸载app,轻松掌... 手机里的App越来越多,是不是感觉内存不够用了?别急,今天就来教你怎么轻松卸载安卓系统里的App,让...
怎么复制照片安卓系统,操作步骤... 亲爱的手机控们,是不是有时候想把自己的手机照片分享给朋友,或者备份到电脑上呢?别急,今天就来教你怎么...
安卓系统应用怎么重装,安卓应用... 手机里的安卓应用突然罢工了,是不是让你头疼不已?别急,今天就来手把手教你如何重装安卓系统应用,让你的...
iwatch怎么连接安卓系统,... 你有没有想过,那款时尚又实用的iWatch,竟然只能和iPhone好上好?别急,今天就来给你揭秘,怎...
iphone系统与安卓系统更新... 最近是不是你也遇到了这样的烦恼?手机更新系统总是失败,急得你团团转。别急,今天就来给你揭秘为什么iP...