返回首页 用 JSON 构建 API 的标准指南
FAQ

URLs

关联文档

确定API的URL结构时,考虑把所有的资源放置于单一“关联文档"是有用的,在关联文档中,每个资源都被分配唯一路径。在文档顶层,资源依据类型分组。在分类资源集合中,单独资源通过ID索引。其属性和links,依据资源对象结构,唯一分配。

关联文档的概念,用于为资源及资源关系确定合适的URLs。重要的一点,出于不同目标和限制,用于传输资源的不同文档中,关联文档的结构有轻微差异。例如,在关联文档中的资源集当做集合处理,因为元素必须通过ID访问,在传输文档中的资源集当做数组处理,因为顺序比较重要。

资源集合URLs

资源集合的URL应该依据资源类型确定。

例如,”photos”类型的资源集合应该使用这种URL:

/photos

单独资源URLs

资源集应该作为集合,依据资源ID索引。单独资源的URL通过为集合URL添加资源ID生成。

例如,ID为"1"的photo使用这种URL:

/photos/1

多个单独资源的URL通过为集合URL添加逗号分隔的资源IDs列表生成。

例如,IDs为"1", "2", "3"的photos使用这种URL:

/photos/1,2,3

替代性URLs

资源的替代性URLs可以选择在响应中指定,或者通过"href"或URL模板指定。

关联 URLs

添加/links/<relationship-name>到资源URL后面,即得到访问特定资源的关联资源URL。相对路径与资源对象内部结构保持一致。

例如,photo的comments链接集使用这种URL:

/photos/1/links/comments

A photo's reference to an individual linked photographer will have the URL: photo的photographer链接使用这种URL:

/photos/1/links/photographer

服务器使用单独资源响应单对象关联,使用资源集合响应多对象关联。

上一篇: 文档结构 下一篇: 资源获取