您的位置首页生活百科

Restful api 的资源内容应不应该带上 ID

Restful api 的资源内容应不应该带上 ID

路径,API的具体地址。在REST中,每个地址都代表一个具体的资源(Resource)。所以就有了以下的约定:

路径仅表示资源的路径(位置),以及一些特殊的actions操作。

以 复数(名词) 进行命名资源,不管返回单个或者多个资源。

使用 小写字母、数字以及下划线(“_”) 。(下划线是为了区分多个单词,如token_access)。

资源的路径从父到子依次如:/{resource}/{resource_id}/{sub_resource}/{sub_resource_id}/{sub_resource_property}。

使用?来进行资源的过滤、搜索以及分页等。

使用版本号,且版本号在资源路径之前。

优先使用内容协商来区分表述格式,而不是使用后缀来区分表述格式。

应该放在一个专用的域名下,如:http://api.webfuse.cn。

建议使用SSL。