RESTful API:“下载资源”端点名称

时间:2018-01-14 13:49:34

标签: rest

我正在构建一个RESTful api,它应该支持下载其中一个服务器资源(文件)的GET请求

我想知道我应该给出这个请求的正确名称(路由)是什么(假设有一个)。

我已经阅读了一些我发现的“最佳实践”文章,但没有一篇与这种情况无关。

我还有:

[GET] /files/file-id

返回有关文件的信息,因此我需要其他东西。 RESTful下载请求是否有最佳实践?

2 个答案:

答案 0 :(得分:4)

Accept标头应控制您的端点返回的内容。例如,如果标头请求XML或JSON,那将返回文件信息,但如果标头请求类似base64或通用二进制类型application/octet-stream的东西,通常会返回文件本身。

这就是“代表性”在REST中的含义。什么都没有真正返回资源本身(理论上) - 您根据客户端请求的内容返回资源的表示

答案 1 :(得分:2)

[GET] /files/file-id应该足够了。这与通常的做法一致,经验丰富的开发人员可以查看该路线,他们将能够正确地假设该路线的作用。

相关问题