标准REST API设计约定

时间:2016-07-04 22:04:39

标签: rest routes restful-architecture restful-url convention

说到严格的REST API设计约定,单个资源可以对应多个路由。

例如,我有路线:

http://www.example.com/registrations
http://www.example.com/confirmations
http://www.example.com/unlocks

所有这些端点都使用用户资源注册新用户,使用确认令牌确认用户,并使用解锁令牌解锁用户。

这是正确的REST设计吗?

1 个答案:

答案 0 :(得分:0)

嗯,没错,但最重要的是你也可能会有一个/user端点,所以可能有更好的方法来扩展它。

例如,解锁可能只是所述/user上的PUT,带有

{
    "state": "unlocked" //active, whatever
}

我不知道你的API的完整范围,但是你可以像我上面那样使用http动词,或者将不同的有效负载发布到同一个端点(例如将confirmToken作为正文中的属性)注册,并重新使用该端点。)