在实际开发中,经常需要自定义 API 返回的响应码及消息,以方便前端或其它调用方对接收到的响应有更全面的理解。ASP.NET Web API 提供了一种简单的方式来实现这种自定义响应模式。
首先,我们需要创建一个继承自 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);
}
}
接着,我们就可以在我们的 API 方法中使用这个自定义 Result 类,例如下面的代码:
[HttpGet] public IHttpActionResult Get() { var message = "Hello World!"; return new CustomResult(message, HttpStatusCode.OK); }
最后,在客户端调用 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 的自定义响应码及返回信息,以满足不同场景的需要。