我应该使用嵌套路由吗？

Question

下面列出了我计划在我的文档采集应用程序中使用的端点。我目前正在与自己辩论是否应该包含/users/{id}/documents 或仅包含/documents。 /users/{id}/documents 意味着我的路线非常嵌套，并且更难维护。

那么你觉得我的 api 设计好看吗，或者有什么你会改变的吗？

GET /documents
POST /documents/new
PUT /documents/{id}/save
DELETE /documents/{id}/delete
PUT /documents/{id}/share

POST /auth/signup
POST /auth/login
GET /auth/loggedin
POST /auth/logout

PUT /users/{id}/password/update
PUT /users/{id}/email/update
PUT /users/{id}/username/update

Answer 1

HTTP 动词也有一些含义。

例如，当您将POST 用于/documents 时，这意味着您要创建一个。所以你不需要/documents/new。 所以我们可以重写路由如下：

GET /documents
POST /documents
PUT /documents/{id}
DELETE /documents/{id}
PUT /documents/share/{id}

POST /auth/signup
POST /auth/login
GET /auth/loggedin
POST /auth/logout

PUT /users/{id}/password
PUT /users/{id}/email
PUT /users/{id}/username

但这完全取决于您必须选择端点。 有些程序员很少使用PUT或DELETE方法。

例如，他们使用POST 删除为/documents/delete/{id}

我个人喜欢使用各种 HTTP 方法