如何设计一个多条件查询的restfulAPI

基础的资源路径:

创建 Create:POST /students
查询 Query:GET /students?age=0,10&name=姓,&q=搜索
获取 Get: GET /students/{studentId}
删除 Destroy:DELETE /students/{studentId}
替换 Update:PUT /students/{studentsId}
补丁 Patch(部分更新):PATCH /students/{studentsId}
替换单个属性 Update Field:PUT /students/{studentId}/{fieldName},请求的 payload 就是对象的字段的值
班级的对应的方式与 Student 的一样,POST /classes 等
班级下的学生: POST /classes/{classId}/students 向班级中添加学生
查询班级下的学生:GET /classes/{classId}/students?age=0,10&name=,姓,&q=搜索
获取班级下学生的详细信息:GET /classes/{classId}/students/{studentId}
……
我们将接口分为以下几种类型:

创建资源:Create,统一为 POST /resource-names
查询资源:Query,统一为 GET /resource-names?q=查询关键字&age=0,10&name=,姓&limit=10&offset=0
获取资源:Get,统一为 GET /resource-names/{recourceId}
删除资源:Destroy,统一为 DELETE /resource-names/{recourceId}
替换资源:Update(全量更新),统一为 PUT /resource-names/{recourceId}
部分更新:Patch(打补丁),统一为 PATCH /resouce-names/{resourceId}/{?fieldName}
操作请求:Action(比如通过审核、激活等对资源的操作)统一为 POST /resouce-names/{resourceId}/action-name
大型查询:Maga Query,比如我们希望从磁带库中查询某一个时间段的数据,可能查询需要很长的时间,那么按以下方式完成:
a. 创建查询: POST /queries,创建一个新的查询,payload 为查询所需要的所有配置参数信息,接口返回 queryId
b. 通过 queryId 获取状态(或者通过 WebSocket 直接通知响起方), GET /queries/{queryId}/status
c. 通过 queryId 获取查询结果 GET /queries/{queryId}/rows?limit=10&offset=0&q=搜索,查询结果得到之后,同样可以对结果进行二次搜索
关于查询参数的规范:

age=0,10 表示查询 age 为 [0, 10) 区间的数据, , 区分起始,同样的还可应用于 时间、日期 等类型的数据
age=,10;20,30;40表示查询 age 为 [0, 10)以及[20,30)以及大于 40 的数据, , 前面表示开始值,若不提供,表示所有小于 , 右侧的值的值,, 右侧表示结束值,若没有,则表示所有大于 , 左侧的值,; 表示多个值的区分。
age=10 表示 age===10 的值
name=姓, 表示以 姓 开头的值,类似 LIKE %姓
name=,名 表示以 名 结尾的值
name=姓名 表示 name 完全等于 姓名 的值
limit 此次查询多少条数据
offset 从 0 开始的偏移量
q 万能的搜索关键字,后端根据需求选择性使用

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 220,367评论 6 512
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,959评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 166,750评论 0 357
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,226评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,252评论 6 397
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,975评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,592评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,497评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 46,027评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,147评论 3 340
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,274评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,953评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,623评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,143评论 0 23
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,260评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,607评论 3 375
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,271评论 2 358

推荐阅读更多精彩内容