REST API状态为整数还是字符串？

Question

我和我的同事正在研究REST API。我们一直在争论资源/项的状态应该是字符串还是整数--我们都需要阅读、理解和修改这个资源（使用单独的应用程序）。由于这是一个非常笼统的主题，谷歌并没有帮助解决这一争论。我想知道你的经验是什么，哪种方式更好。

例如，假设我们有作业资源，它可以通过URI http://example.com/api/jobs/someid访问，它具有以下JSON表示形式，存储在NoSQL DB中：

JOB A:
{
   "id": "someid",
   "name": "somename",
   "status": "finished"  // or "created", "failed", "compile_error"
}

所以我的问题是-也许它应该更像是跟随？

JOB B:
{
   "id": "someid",
   "name": "somename",
   "status": 0  // or 1, 2, 3, ...
}

• 状态==50-表示网络组件X有问题，
• 状态>100-表示某些多个特殊情况。

当你有数字的时候，你就不需要为它们编所有那些字符串名了。那么在你看来哪种方式是最好的呢？也许我们需要多个字段（这会让事情有点混乱）：

JOB C:
{
   "id": "someid",
   "name": "somename",
   "status": 0, // or 1, 2, 3...
   "error_type": "compile_error",
   "error_message": "You coding skill has failed. Please go away"
}

Answer 1

就我个人而言，我将考虑将你提到的两种方法结合起来处理这种情况。我会将状态作为整数存储在数据库中，但会创建一个枚举或常量类来将状态名映射到数值状态值。

例如（在C#中）：

public enum StatusType
{
    Created = 0,
    Failed = 1,
    Compile_Error = 2,

    // Add any further statuses here.
}

然后，您可以将数据库中存储的数字状态转换为该枚举的实例，并在整个代码中使用该实例进行决策。

StatusType status = (StatusType) storedStatus;

if(status == StatusType.Created)
{
    // Status is created.
}
else
{
   // Handle any other statuses here.
}

如果你是迂腐的，你也可以将这些映射存储在你的DB中。

对于通过API进行访问，您可以根据您的需求选择任何一种方式。您甚至可以返回一个包含状态号和状态文本的结果：

object YourObject
{
    status_code = 0,
    status = "Failed"
}

您还可以创建一个API来从代码中检索状态名。但是，从性能的角度来看，在API中同时返回状态代码和名称将是最好的。