RESTful设计规范
一、 摘要(Abstract) RESTful API 已经非常成熟,也得到了大家的认可。我们按照 Richardson Maturity Model 对 REST 评价的模型,规范基于 level2 来设计 二、版本(Versioning) API的版本号放入URL。例如: https: // api.jiuyescm.com /v1/ https: // api.jiuyescm.com /v1.2/ 三、资源、路径(Endpoint) 路径,API的具体地址。在REST中,每个地址都代表一个具体的资源( Resource )约定如下: 路径仅表示资源的路径(位置),尽量不要有actions操作(一些特殊的 actions 操作除外) 路径以 复数(名词) 进行命名资源,不管返回单个或者多个资源。 使用 小写字母、数字以及下划线(“_”) 。(下划线是为了区分多个单词,如user_name) 资源的路径从父到子依次如: /{resource}/ {resource_id} /{sub_resource}/ {sub_resource_id}/{sub_resource_property} 使用 ? 来进行资源的过滤、搜索以及分页等 使用版本号,且版本号在资源路径之前 优先使用内容协商来区分表述格式,而不是使用后缀来区分表述格式 应该放在一个专用的域名下,如: http:/