执行会员提现功能的api应该使用哪个url名称

问题描述 投票:0回答:1

Q1。 API规范中使用“注销”这个词可以吗? 或者我应该使用“注销”? 哪个更好?

Q2。我想知道会员退出API的实际逻辑是否只是将用户状态更改为“待处理”,我可以指定API的HTTP方法进行DELETE,还是应该使用PATCH?

“用户提现API”哪种HTTP方法更RESTful?

我尝试“注销”我们服务的用户提现 API 的名称,但这可能会误导开发人员将其理解为“注销”,所以我想知道常见的命名约定。

api-design naming restful-url http-method
1个回答
0
投票

这里有一些想法。没有绝对的正确和错误 - 也许更重要的是与现有的 REST 结构保持一致

  • 如果您完全删除用户,那么他们根本不再存在:

    DELETE /api/users/{id}

  • 如果您将用户保留在系统中,但将其从活动用户列表中删除,请考虑从子集合中删除它们的理念:

    DELETE /api/users/active/{id}

  • 您已经提到了补丁。我个人不喜欢这样,因为它让客户端有责任“知道”需要修补哪些字段。没关系,虽然它只是一个“状态”字段......但是如果您需要引入带有额外字段的更复杂的状态(例如“停用日期”),那么要么客户端会崩溃,要么补丁需要被服务器(这并不真正符合它的精神)。通过使用简单的 DELETE 动词(如上面的两个选项),您就可以免受这种情况的影响。

© www.soinside.com 2019 - 2024. All rights reserved.