设计一对一的休息服务

时间:2014-08-28 08:05:41

标签: rest architecture restful-architecture spring-data-rest

场景:我们正在创建/设计REST服务以帮助我们配置系统(及其网络等),但我们遇到了与设计此API相关的一些问题。我们想使用REST调用/

配置系统的主机名

挑战:由于大多数API和设计指南都与实体列表相关,而不仅仅是单个实体列表,因此我无法决定其余API的外观。

目前我们正在考虑使用以下内容:

  • GET /system/0
  • PUT /system/0 {....}

问题:只有一个系统实体,因此使用0识别此功能并不好,因为只有一个。

是否有关于如何进行此操作的REST指南?

1 个答案:

答案 0 :(得分:0)

实际上,REST不会为URL强制执行特定格式,您甚至可以使用/569284d7-1b59-4343-92d4-90e8753bcbd7这样的网址,这样就可以了。在REST中,服务器通过状态更改引导客户端,而不是客户端知道要访问的URL。

大多数Web API都是以CRUD样式创建的,具有类似于示例/system/0/system/1的资源层次结构,因为它更容易理解和实现(可能并不总是RESTful,具体取决于耦合的紧密程度客户端是URL,但它满足大多数需求,所以人们选择这样做。)

所以我的建议是保持简单,不要过度思考。即使现在只有一个系统,使用/system/0也没关系。

只需2美分!