Question

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

例如，假设我们有 Job 资源，可通过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, ...
}

在这两种情况下，我们每个人都必须创建一个地图，我们用它来理解我们的应用程序逻辑中的状态。但我自己倾向于第一个，因为它更具可读性......你也可以轻松混淆'0'（字符串）和 0 （数字）。

但是，由于API由机器使用，因此可读性并不重要。使用数字还有一些其他优点 - 在控制台中使用应用程序时它被广泛接受，并且当您想要包含任意新的失败状态时可能是有益的，例如：

status == 50 - 表示您遇到网络组件X的问题，
状态＆gt; 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.
}

然后，您可以将存储在数据库中的数字状态转换为此枚举的实例，并将其用于整个代码的决策制作。

例如（在C＃中）：

StatusType status = (StatusType) storedStatus;

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

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

要通过API进行访问，您可以根据自己的要求选择其中一种方式。您甚至可以使用状态编号和状态文本返回结果：

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

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

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

1 个答案: