如何使用 .NET Web API 处理状态代码？

Question

我是 .NET Web api 的新手。但我无法弄清楚返回状态代码时的最佳做法应该是什么。我已经按照creating a web api that supports crud operations 上的教程了解了它是如何工作的。

我有一个规范，其中对每个请求的响应都会返回一个状态代码以及其他数据，如果需要，我可以更改规范，但我无法确定返回状态代码并返回所有请求的数据或仅自行返回数据。

例如，如果我在未经身份验证的情况下向 GetAllCarManufacturers 发出请求，我将返回 1 的自定义 statusCode（表示未经过身份验证）和 message "User is not authenticated."。但如果我通过了身份验证，我想发回statusCode 或0（表示成功）和所有汽车制造商。这似乎与本教程的组织方式背道而驰，因为只有汽车制造商在没有任何额外数据的情况下被送回。这让我相信传递 statusCode 不是正确的做法。

我在示例 crud 演示中看到抛出 HttpResponseExceptions 将 HttpStatusCode 设置为某个值（参见下面的代码）。我应该使用它而不是返回我自己的状态码吗？但我担心的是它没有足够的不同状态代码来匹配我的自定义场景。

// Setting the HTTPStatusCode example.
throw new HttpResponseException(HttpStatusCode.NotFound);

Answer 1

.NET Web API 为支持 REST 接口的服务器设置 HTTP 调用约定。因此，如果您遵循约定，您应该返回 HTTP 状态代码作为指示服务器处理请求时发生了什么情况的一种方式。

HTTP 状态码是 HTTP 规范的一部分，可以是 found here。

使用 HTTP 状态码有很多好处。一种是 HTTP 状态码是一个标头，因此客户端不必查看响应的内容即可了解发生了什么。

因此，如果 HTTP 客户端希望从您的界面获得 RESTful 体验，那么返回自定义状态代码（例如 0 或 1）对他们来说不是很有用。