没有正文的 RESTful API POST 调用请求

Question

我想在我的 API 中创建一个新调用，将两个已创建的资源链接在一起。因此，我不需要在帖子正文中传递任何 json 实体，我只需要在 URL 中传递的资源 ID。这是错误的做法吗？所以基本上我现在的请求只是一个简单的路径 {cid}/projects/{projectID}/subcontractors/{subcontractorID}在后调用方法中，我从路径中提取资源 ID 并将它们链接起来。响应只有通过或失败 {"success":true}。这是错误的做法吗？有更好的方法吗？

Answer 1

如何设计 API 完全取决于您。从技术角度来看，带有空负载的 POST 请求完全没问题。

---

但是，假设您打算将一个承包商添加到一个项目，我认为它可以用有效载荷更好地表达:

POST /projects/1/contractors HTTP/1.1
Host: api.example.org
Content-Type: application/json

{ "contractorId": 100 }

如果您需要管理该项目 中该承包商 的更多信息，则此方法特别有用。如果上述请求成功，响应将包含 201 状态代码以及标识新创建资源的 Location header 。