REST API URL设计最佳做法

时间:2020-01-18 08:04:08

标签: rest api url

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

/process/flow

/process/threshold

/general/name 

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

/param/{id}

1 个答案:

答案 0 :(得分:0)

REST API URL设计最佳做法

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

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

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

这意味着服务器可以将标识资源所需的任何信息嵌入URI中-不管是人类可读的令牌,代理密钥还是哈希……都很好。