node.js - 在 REST API 中请求文档与文档详细信息的正确架构是什么？

Question

我正在使用 NodeJS 和 Express 设计一个 REST API，用于管理不同类型的文档(txt、pdf、doc 等)。文档模型类似于:

   {
   id,
   category,
   name,
   path,
   tags,
   etc.. 
   }

我目前有一个获取单个文档的路线。/documents/:id该路线提供实际的文档。我希望获得一些有关提供文档详细信息(即名称、类别等)的正确方法的指导。我应该使用不同的 URL 吗？在 header 中发送详细信息？使用response.format？让客户端通过查询指定？

编辑:我应该澄清的是，这些文档将存储在服务器文件系统上，并且任何客户端都无法直接访问。

Answer 1

如果文档详细信息来自不同的来源，最直接的方法是设置不同的端点 /document-details/:id。

否则，如果文档可以字符串化为 JSON，则可以将两者嵌套在同一响应中:

{
  document: {},
  details: {
    category,
    name,
    path,
    tags
  }
}

我建议不要在 HTTP header 中发送有关文档的任何详细信息，这些详细信息通常用于发送有关响应本身的详细信息。