RESTful API URI设计:层次结构

时间:2017-10-01 19:06:08

标签: rest

如下所示的模型,用户(管理员)可以有多个位置,地方可以由多个用户(非管理员)管理,而地方可以有多个表,许多客户,部门等:

                --> Table
User <--> Place --> Customer
                --> Section

Notation: <--> many to many
           --> one to many

这个RESTful API实现是否根据REST准则设计得很好?我不确定是否应该使用层次级别来实现API。

REST API,包括括号中每个端点的HTTP有效方法:

/api/places                            [GET, POST]
/api/places/<name>                     [GET, PUT, DELETE]
/api/places/<name>/customers           [GET, POST]
/api/places/<name>/customers/<id>      [GET, PUT, DELETE]
/api/places/<name>/tables              [GET, POST]
/api/places/<name>/tables/<id>         [GET, PUT, DELETE]
/api/places/<name>/users               [GET, POST]
/api/places/<name>/users/<username>    [GET, PUT, DELETE]

1 个答案:

答案 0 :(得分:0)

REST没有关于如何定义网址层次结构的指南。

您的网址设计看起来足够精细,让人们了解您的api的结构。