使用 RestApi 选择资源下载文件的最佳方法是什么?

2024-02-02

我需要下载一个文件,但是我想知道哪种方法是发布我的资源的最佳方法。 假设我有一个文档

http://api/documents/id

我在哪里发出 GET 请求,是否应该接收具有该 id 的文档信息,包括一个额外字段,其中包含 BASE64 中文件的字符串表示形式?或者我应该发布另一个网址资源,例如

http://api/documents/id/download

只是为了获取文件?第一个我知道该怎么做,但我不知道这是否是正确的方法。对于后者我需要建议。


据我了解你的document资源由元数据和文档的实际内容组成。因此,您可以支持以下内容:

  • GET /documents/:id:返回文档元数据的表示
  • GET /documents/:id/content:返回文档内容的表示

或者,您可以支持单个端点,例如GET /documents/:id并在多部分响应中返回元数据和内容。


不过,内容谈判将是最好的方法。您可以使用单个端点,例如GET /documents/:id and Accept: application/json对于元数据,例如Accept: application/octet-stream为内容。

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

使用 RestApi 选择资源下载文件的最佳方法是什么? 的相关文章

随机推荐