ASP.NETWebAPIOwnResponseCodePatternSuggestion”如何实现自定义响应码及返回信息?
创始人
2024-09-19 13:31:47
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 的自定义响应码及返回信息,以满足不同场景的需要。

相关内容

热门资讯

保存时出现了1个错误,导致这篇... 当保存文章时出现错误时,可以通过以下步骤解决问题:查看错误信息:查看错误提示信息可以帮助我们了解具体...
汇川伺服电机位置控制模式参数配... 1. 基本控制参数设置 1)设置位置控制模式   2)绝对值位置线性模...
不能访问光猫的的管理页面 光猫是现代家庭宽带网络的重要组成部分,它可以提供高速稳定的网络连接。但是,有时候我们会遇到不能访问光...
本地主机上的图像未显示 问题描述:在本地主机上显示图像时,图像未能正常显示。解决方法:以下是一些可能的解决方法,具体取决于问...
不一致的条件格式 要解决不一致的条件格式问题,可以按照以下步骤进行:确定条件格式的规则:首先,需要明确条件格式的规则是...
表格中数据未显示 当表格中的数据未显示时,可能是由于以下几个原因导致的:HTML代码问题:检查表格的HTML代码是否正...
表格列调整大小出现问题 问题描述:表格列调整大小出现问题,无法正常调整列宽。解决方法:检查表格的布局方式是否正确。确保表格使...
Android|无法访问或保存... 这个问题可能是由于权限设置不正确导致的。您需要在应用程序清单文件中添加以下代码来请求适当的权限:此外...
【NI Multisim 14...   目录 序言 一、工具栏 🍊1.“标准”工具栏 🍊 2.视图工具...
银河麒麟V10SP1高级服务器... 银河麒麟高级服务器操作系统简介: 银河麒麟高级服务器操作系统V10是针对企业级关键业务...