Rest api 设计规范

一、Api资源分类


根据使用对象以及应用场景不同,我们把Api划分为 免费资源,移动端资源、联合资源。

1、Free 免费资源

地址:/free/****

描述:该类资源主要是用于不涉密公共基础数据服务,在开发前端业务组件时常会使用到该类数据服务。

2、Unity 联合资源

地址:/unity/****

描述:主要提供给web 与 client 使用,该类资源需要进行权限认证。

3、 Mobile 移动资源

地址:/mobile/****

描述:主要提供给移动端使用,该类资源也需要进行权限认证。

二、命名规范


1、使用英文全小写,组合词使用“-”连接,尽量不要用英文简写或中文拼音等

三、地址规范


1、语意须简要、清晰。所表达的意思要逐级递进

2、对于语意不明确的可采用*****?state=cache 来修饰

四、地址约定


4.1 常见场景地址约定设计

1、分页查询

xxxx/department/page

2、条件查询

xxxx/department/query

3、主键获取

xxxx/department/{id}

4、多结果单值条件获取

xxxx/department/list?level=2

5、tree型数据获取

xxxx/department/tree

6、子级数据获取

xxxx/department/child/{parentId}

7、同级数据获取

xxx/department/siblings/{id}

8、父亲数据获取

xxx/department/parent/{childId}

9、祖先数据获取

xxx/department/parents/{childId}

10、所有数据获取

xxx/department/all

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

推荐阅读更多精彩内容

  • 前言:如果你有更好的私藏文章,不凡分享出来,独乐乐不如众乐乐(⊙o⊙) 本文总结了 RESTful API 设计相...
    utopia84阅读 4,008评论 2 35
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,566评论 18 139
  • 小伙伴们拿到R11手机后是不是都在纠结如何关闭R11/Plus的按键灯?, 就是按键灯一直亮着,不仅看着不舒服,而...
    phone人院长勇哥阅读 1,512评论 0 0
  • 今天是端端第三天讲着故事入睡。 其实他内心对nn还是非常的渴望,大人们都挺坏的,想办法治小孩,我找到自己的问题所在...
    Jessica_ff17阅读 156评论 0 0
  • 我认真的读完的一本名著是《三国演义》。从小学开始,断断续续间隔几年读完了这本书。书中的人物影响了我,塑造了我的性格...
    安碌阅读 188评论 0 1