c# - 单个整数的 Web API ResponseType

Question

调用仅返回单个整数的 Web API REST 服务的“正确”方法是什么？

我在这里对 XML、JSON 或任何其他方面没有要求。对服务的调用只需要返回一个整数。

我在这里使用 ResponseType 属性吗？

我的服务返回类型为 HttpResponseMessage，对于诸如返回 JSON 之类的服务，我会将其 Content 属性设置为 StringContent 并使用 UTF8 "application/json ".

但是对于单个整数，什么是正确的？

Answer 1

我建议您为 API 方法使用 IHttpActionResult 类型。它将允许您使用几种不同的便捷方法来返回常见的响应。在您的情况下，它看起来像这样:

public IHttpActionResult GetInteger() {
   // Ok is a convenience method for returning a 200 Ok response
   return Ok(1);
}

或者，如果您想将其包装在一个对象中以方便 JSON 使用，匿名对象也可以:

public IHttpActionResult GetInteger() {
   // Ok is a convenience method for returning a 200 Ok response
   return Ok(new {
      value = 1
   });
}

Documentation here

从文档中总结了一些您会使用 IHttpActionResult 的原因:

• 简化 Controller 的单元测试。
• 将创建 HTTP 响应的通用逻辑移到单独的类中。
• 通过隐藏构建响应的底层细节，使 Controller 操作的意图更加清晰。