应该在 API 中返回自然键还是代理键？
Should the natural or surrogate key be returned in an API?
第一次想到...
直到现在，我一直在 API 中使用自然键。例如，REST API 允许处理实体，URL 类似于 /entities/{id}，其中 id 是用户已知的自然键（ID 传递给 POST 创建实体的请求）。创建实体后，用户可以使用多个命令（GET、DELETE、PUT...）来操作实体。该实体还有一个由数据库生成的代理键。
现在，考虑以下顺序：
- 用户创建了 ID 为 1 的实体。（
POST /entities 正文包含 ID 1）
- 另一个用户删除了该实体（
DELETE /entities/1）
- 同一位其他用户再次创建实体（
POST /entities 正文包含 id 1）
- 第一个用户决定修改实体（
PUT /entities/1 with body）
在执行第4步之前，数据库中还有id为1的实体，但不是第1步中创建的同一个实体。问题是第4步根据自然识别要修改的实体已删除实体和新实体的密钥相同（而代理密钥不同）。因此，第 4 步会成功，用户永远不会知道它正在处理一个新实体。
我通常也在我的应用程序中使用乐观锁定，但我认为它在这里没有帮助。第一步之后，实体的版本字段为0。第三步之后，新实体的版本字段也为0。因此，版本检查将无济于事。使用时间戳字段进行乐观锁定是否正确？
"good" 解决 return 代理键给用户？这样，用户总是向服务器提供代理键，服务器可以使用它来确保它在同一个实体上工作，而不是在新实体上工作？
您推荐哪种方法？
这取决于您希望用户如何使用您的 api。
REST APIs 应该尽量被发现。因此，如果在您的 API 中公开自然键有好处，因为它允许用户直接修改 URI 并进入新状态，那就去做吧。
类别或标签就是一个很好的例子。我们可以有这些以下 URI；
GET /some-resource?tag=1 // returns all resources tagged with 'blue'
GET /some-resource?tag=2 // returns all resources tagged with 'red'
或
GET /some-resource?tag=blue // returns all resources tagged with 'blue'
GET /some-resource?tag=red // returns all resources tagged with 'red'
第二组用户显然更有价值，因为他们可以看到标签是真实的单词。然后，这允许他们在其中键入任何单词以查看返回的内容，而第一组不允许这样做：它限制了可发现性
另一个例子是订单
GET /orders/1 // returns order 1
或
GET /orders/some-verbose-name-that-adds-no-meaning // returns order 1
在这种情况下，为订单添加一些冗长的名称以使其可被发现的价值不大。用户更可能希望先查看所有订单（或子集）并按日期或价格等进行筛选，然后选择一个订单进行查看
GET /orders?orderBy={date}&order=asc
额外
经过我们的聊天讨论，您的问题似乎与版本控制和如何管理资源锁定有关。
如果您允许多个用户修改资源，您需要在每个请求和响应中发送一个版本号。进行任何更改时，版本号都会递增。如果请求在尝试修改资源时发送旧版本号，则抛出错误。
如果您允许重复使用相同的 URI，则可能会发生冲突，因为版本号始终从 0 开始。在这种情况下，您还需要发送一个 GUID（代理键）和版本号。或者不要使用自然 URI（请参阅上面的原始答案来决定何时执行此操作）。
还有一个选项是禁止重用 URI。这实际上取决于用例和您的业务需求。重用 URI 可能没问题，因为在概念上它意味着同一件事。例如，如果您的计算机上有一个文件夹。删除文件夹并重新创建它与清空文件夹相同。从概念上讲，该文件夹是相同的 'thing'，但具有不同的属性。
用户帐户可能是重用 URI 不是一个好主意的领域。如果您删除一个帐户 /accounts/u1，该 URI 应该被标记为已删除，并且其他用户应该无法创建用户名为 u1 的帐户。从概念上讲，使用相同 URI 的新用户与前一个用户使用时不同。
您提到了使用时间戳作为乐观锁定的可能性。
根据您遵循 RESTful 原则的严格程度，由 POST 编辑的实体 return 将包含 "edit self" link；这是可以对其执行删除或更新的 URI。
以您上面的步骤为例：
步骤 1
用户 A 执行实体 1 的 POST。returned 实体对象将包含一个 "self" link 指示更新应发生的位置，例如：
/entities/1/timestamp/312547124138
步骤 2
用户 B 获取现有实体 1，具有上述 "self" link，并对该时间戳版本化 URI 执行删除。
步骤 3
用户 B 对新实体 1 进行了 POST，其中 return 是一个具有不同 "self" link 的对象，例如：
/entities/1/timestamp/312547999999
步骤 4
用户 A 使用他们在第 1 步中获得的原始实体，尝试对他们对象上的 "self" link 执行 PUT，即：
/entities/1/timestamp/312547124138
...您的服务将识别出尽管实体 1 确实存在；用户 A 正在尝试针对已过时的版本执行 PUT。
服务然后可以执行适当的操作。根据算法的复杂程度，您可以合并更改或拒绝 PUT。
我不记得你应该 return 的适当的 HTTP 状态代码，跟随一个 PUT 到一个陈旧的版本...这不是我在我工作的 Rest 框架中实现的东西，尽管我计划在将来启用它。可能是你 return 410 ("Gone").
步骤 5
我知道您没有第 5 步，但是..！用户 A 在发现他们的 PUT 失败后，可能会重新检索实体 1。这可能是他们（陈旧的）版本的 GET，即 GET 到：
/entities/1/timestamp/312547124138
...并且您的服务会 return 从该对象的通用 URI 重定向到 GET，例如：
/entities/1
...或特定的最新版本，即：
/entities/1/timestamp/312547999999
然后他们可以根据任何应用程序级合并逻辑进行第 4 步中预期的更改。
希望对您有所帮助。
您的问题可以通过使用 ETag 进行版本控制（只有提供当前 ETag 才能修改记录）或通过软删除（因此删除的记录仍然存在但带有一个被 PUT 重置的垃圾布尔值）来解决).
听起来您还可以从批处理端点和使用事务中获益。
看到人们试图重新发现已知问题的解决方案很有趣。此问题并非特定于 REST API - 它适用于任何索引存储。我见过的唯一解决方案是不要重复使用代理键。
如果您在客户端生成代理密钥，请使用 UUID 或拆分序列，但最好在服务器端生成。
此外，如果数据中存在简单的自然键，您应该永远不要使用代理键取消引用数据。事实上，即使自然键是复合实体，您也应该非常仔细地考虑是否在 API.
中公开代理键。
第一次想到...
直到现在，我一直在 API 中使用自然键。例如，REST API 允许处理实体，URL 类似于 /entities/{id}，其中 id 是用户已知的自然键（ID 传递给 POST 创建实体的请求）。创建实体后，用户可以使用多个命令（GET、DELETE、PUT...）来操作实体。该实体还有一个由数据库生成的代理键。
现在，考虑以下顺序：
- 用户创建了 ID 为 1 的实体。（
POST /entities正文包含 ID 1） - 另一个用户删除了该实体（
DELETE /entities/1） - 同一位其他用户再次创建实体（
POST /entities正文包含 id 1） - 第一个用户决定修改实体（
PUT /entities/1with body）
在执行第4步之前，数据库中还有id为1的实体，但不是第1步中创建的同一个实体。问题是第4步根据自然识别要修改的实体已删除实体和新实体的密钥相同（而代理密钥不同）。因此，第 4 步会成功，用户永远不会知道它正在处理一个新实体。
我通常也在我的应用程序中使用乐观锁定，但我认为它在这里没有帮助。第一步之后，实体的版本字段为0。第三步之后，新实体的版本字段也为0。因此，版本检查将无济于事。使用时间戳字段进行乐观锁定是否正确？
"good" 解决 return 代理键给用户？这样，用户总是向服务器提供代理键，服务器可以使用它来确保它在同一个实体上工作，而不是在新实体上工作？
您推荐哪种方法？
这取决于您希望用户如何使用您的 api。
REST APIs 应该尽量被发现。因此，如果在您的 API 中公开自然键有好处，因为它允许用户直接修改 URI 并进入新状态，那就去做吧。
类别或标签就是一个很好的例子。我们可以有这些以下 URI；
GET /some-resource?tag=1 // returns all resources tagged with 'blue'
GET /some-resource?tag=2 // returns all resources tagged with 'red'
或
GET /some-resource?tag=blue // returns all resources tagged with 'blue'
GET /some-resource?tag=red // returns all resources tagged with 'red'
第二组用户显然更有价值，因为他们可以看到标签是真实的单词。然后，这允许他们在其中键入任何单词以查看返回的内容，而第一组不允许这样做：它限制了可发现性
另一个例子是订单
GET /orders/1 // returns order 1
或
GET /orders/some-verbose-name-that-adds-no-meaning // returns order 1
在这种情况下，为订单添加一些冗长的名称以使其可被发现的价值不大。用户更可能希望先查看所有订单（或子集）并按日期或价格等进行筛选，然后选择一个订单进行查看
GET /orders?orderBy={date}&order=asc
额外
经过我们的聊天讨论，您的问题似乎与版本控制和如何管理资源锁定有关。
如果您允许多个用户修改资源，您需要在每个请求和响应中发送一个版本号。进行任何更改时，版本号都会递增。如果请求在尝试修改资源时发送旧版本号，则抛出错误。
如果您允许重复使用相同的 URI，则可能会发生冲突，因为版本号始终从 0 开始。在这种情况下，您还需要发送一个 GUID（代理键）和版本号。或者不要使用自然 URI（请参阅上面的原始答案来决定何时执行此操作）。
还有一个选项是禁止重用 URI。这实际上取决于用例和您的业务需求。重用 URI 可能没问题，因为在概念上它意味着同一件事。例如，如果您的计算机上有一个文件夹。删除文件夹并重新创建它与清空文件夹相同。从概念上讲，该文件夹是相同的 'thing'，但具有不同的属性。
用户帐户可能是重用 URI 不是一个好主意的领域。如果您删除一个帐户 /accounts/u1，该 URI 应该被标记为已删除，并且其他用户应该无法创建用户名为 u1 的帐户。从概念上讲，使用相同 URI 的新用户与前一个用户使用时不同。
您提到了使用时间戳作为乐观锁定的可能性。
根据您遵循 RESTful 原则的严格程度，由 POST 编辑的实体 return 将包含 "edit self" link；这是可以对其执行删除或更新的 URI。
以您上面的步骤为例：
步骤 1
用户 A 执行实体 1 的 POST。returned 实体对象将包含一个 "self" link 指示更新应发生的位置，例如：
/entities/1/timestamp/312547124138
步骤 2
用户 B 获取现有实体 1，具有上述 "self" link，并对该时间戳版本化 URI 执行删除。
步骤 3
用户 B 对新实体 1 进行了 POST，其中 return 是一个具有不同 "self" link 的对象，例如：
/entities/1/timestamp/312547999999
步骤 4
用户 A 使用他们在第 1 步中获得的原始实体，尝试对他们对象上的 "self" link 执行 PUT，即：
/entities/1/timestamp/312547124138
...您的服务将识别出尽管实体 1 确实存在；用户 A 正在尝试针对已过时的版本执行 PUT。
服务然后可以执行适当的操作。根据算法的复杂程度，您可以合并更改或拒绝 PUT。
我不记得你应该 return 的适当的 HTTP 状态代码，跟随一个 PUT 到一个陈旧的版本...这不是我在我工作的 Rest 框架中实现的东西，尽管我计划在将来启用它。可能是你 return 410 ("Gone").
步骤 5
我知道您没有第 5 步，但是..！用户 A 在发现他们的 PUT 失败后，可能会重新检索实体 1。这可能是他们（陈旧的）版本的 GET，即 GET 到：
/entities/1/timestamp/312547124138
...并且您的服务会 return 从该对象的通用 URI 重定向到 GET，例如：
/entities/1
...或特定的最新版本，即：
/entities/1/timestamp/312547999999
然后他们可以根据任何应用程序级合并逻辑进行第 4 步中预期的更改。
希望对您有所帮助。
您的问题可以通过使用 ETag 进行版本控制（只有提供当前 ETag 才能修改记录）或通过软删除（因此删除的记录仍然存在但带有一个被 PUT 重置的垃圾布尔值）来解决).
听起来您还可以从批处理端点和使用事务中获益。
看到人们试图重新发现已知问题的解决方案很有趣。此问题并非特定于 REST API - 它适用于任何索引存储。我见过的唯一解决方案是不要重复使用代理键。
如果您在客户端生成代理密钥，请使用 UUID 或拆分序列，但最好在服务器端生成。
此外，如果数据中存在简单的自然键，您应该永远不要使用代理键取消引用数据。事实上，即使自然键是复合实体，您也应该非常仔细地考虑是否在 API.
中公开代理键。