RESTful API设计实例

目录

基本架构

模拟实例

理论依据

实例

从属关系

并列关系

总结

API设计

代码与RESTful API

需求：用户组管理

创建/编辑用户组

删除用户组

列举用户组

规划数据集

把数据集划分为资源

用URI为资源命名

---

基本架构

若待定义的数据类型可由其他数据组合而成，则直接使用allOf，如下图所示。

若数据有多重描述形式，使用多态（oneOf），如下图所示。

模拟实例

理论依据

url是数据的地址，json是数据的描述，数据之间存在从属和并列关系

实例

有一个文件表file

从属关系

表file的从属数据是文件总数items_count，所有文件items，items的从属数据是每个文件的数据item
在url中的表现：斜杠分隔的层级关系，/file/items_count，/file/items，/file/items/item1,item2
在json中的表现：file object内包含items_count和items字段，items array内包含item1,item2元素

并列关系

表file中的items_count和items，items中的各个item之间
在url中的表现：逗号分隔的并列关系，/file/items_count,items，/file/items/item_id1,item_id2
在json中的表现：file object中items_count和items字段，items array中item1,item2元素

总结

1. 数据之间的从属与并列关系，均可以通过数据的唯一标识即预定义的名字（object中字段的key）或随机生成的id（array中元素的id），在url和json中表达，即object中字段的key和array中元素的id，均可出现在url和json中
2. 并列关系的数据&#x