前后端 api 接口 url 格式问题讨论

[pandazhong123]

公司的前后端 api 接口统一用 post,对于添加删除用户，是用 /user/add /user/delete 比较好，还是用 /add/user /delete/user 比较好？

[radiocontroller]

GET /users 用户列表

[radiocontroller]

@radiocontroller

[radiocontroller]

restful
GET /users 用户列表
POST /users 新增用户
GET /users/{id} 用户详情
PATCH /users/{id} 更新用户
DELETE /users/{id} 删除用户

[csrocks]

https://learn.microsoft.com/en-us/azure/architecture/best-practices/api-design#organize-the-api-design-around-resources

[Chad0000]

两种风格都可：

/user/add
/user/delete

post /user
delete /user/{userId}

[clf]

@radiocontroller #23 RESTFUL 除非是自己的 SSAS 系统，那随便用，交付给客户的还是用 GET 和 POST 。避免遇到客户的安全策略禁了一堆请求方法。

----

/user/add /user/delete 肯定会更好，还有一种是 user/add_user user/delete_user

[gesse]

推荐 easydoc 的启蒙系列文章
https://easydoc.net/a/api-design/

[Pastsong]

/user:add

/user/add 会和 /user/{userId} 或者 /user/{userName} 冲突，万一有用户叫 add 呢

[theqiang]

@nothingistrue #15 人家说了用 POST.....

[hidemyself]

上面有 RESTful 风格的 api
我想问下，
根据用户 id 删除用户是 DELETE user/{id}
如果我有个接口是根据用户手机号删除用户，应该怎么命名

[worldqiuzhi]

上次 v 站刚有一个用非 POST 方法过等保被拒的 GET /users 用户列表
POST /users 新增用户
GET /users/{id} 用户详情
PATCH /users/{id} 更新用户
DELETE /users/{id} 删除用户

[lanlanye]

全 POST 的话我也有个邪道做法：

POST '{prefix}/users/{id}' \
--data-raw '{"method": "DELETE", "data": null}'

[PiersSoCool]

都可以

风格差不多一致就行

就怕不一致的

[coderxy]

有的后端是微服务， 按照 /user /post 这样的前缀去分发服务的。 这种你就只能按照后端规则来了。

[estk]

tRPC 让前后端一起闭嘴

[Crapulence]

第一种 可以一眼看到针对 user 下的资源进行操作

[yugali]

@hidemyself 根据手机号找到用户，然后 DELETE user/{id}

[johnnyNg]

post,然后 data 里面包含 path 、method

[arfaWong]

@hidemyself #30 问的 chatgpt 😂

根据 RESTful 风格的 API 设计原则，您可以将根据用户手机号删除用户的接口进行命名。以下是一个可能的命名方案：

DELETE /user/phone/{phoneNumber}

在上述命名中，您可以使用"user"作为资源的基本路径，然后使用"phone"来指示后续路径是基于用户手机号进行操作。最后，使用"{phoneNumber}"作为占位符表示要删除的具体手机号。

[cdwyd]

第一种更舒服些，把要操作的对象统一放到了最前面，写文档的时候看起来也更好看一点