REST API URL设计最佳实践

Question

我正在为一个有很多设置参数的系统开发REST API。所有这些参数都应该能够更改。这些参数按类别分组，并具有唯一的名称。参数具有不同的测量单位，并且它们具有不同的类型(布尔值、数字或具有多个属性的对象)。例如，我有属于类别"process“的参数"flow”和"threshold“，以及属于类别"general”的参数"name“。定义URL的常用方法是什么？是不是：

/process/flow

/process/threshold

/general/name 

或者每个参数都有一个唯一的编号(id)更好。并且无需使用类别，URL可以简单地定义如下：

/param/{id}

Answer 1

REST API设计最佳实践

REST并不关心URL设计。只要您使用的标识符符合RFC 3986描述的产生式规则，您就可以使用您喜欢的任何拼写。

/general/name
/param/12345
/3eaa7b95-c46b-4290-9614-546dc17c1f2d

这些都很好。从通用组件(如web浏览器或缓存)的角度来看，URI是不透明的--我们从不“解析”URI以从中提取语义信息。

这意味着服务器可以在URI中嵌入标识资源所需的任何信息--无论是人类可读的令牌、代理键还是散列...一切都很好。