API 入门 (26) 设计 API 的数据——查询参数数据

上一篇文章中,我们设计了响应的数据结构。本文继续介绍如何设计参数的数据结构。

在添加、更新一个自行车资源时,需要将自行车的信息作为参数传递给 API 的操作。那么,这个参数需要包含哪些信息呢?

我们先回顾一下自行车的属性信息,再根据具体的操作进行分析。

自行车的属性:

  1. 编号:reference
  2. 名称:name
  3. 价格:price
  4. 重量:weight
  5. 上架日期:dateAdded
  6. 描述:description

添加自行车

在添加一个新的自行车资源时,自行车的编号属性,是由后端服务根据业务规则生成的,不需要管理员提供。再来看看上架日期。上架日期应该等同于管理员添加自行车时的日期和时间,也不需要管理员手动添加,由后端服务自动添加即可。因此,在添加自行车资源时,需要下列属性作为参数信息:

  1. 名称:name
  2. 价格:price
  3. 重量:weight
  4. 描述:description

更新自行车

在更新一个自行车资源时,自行车的编号是需要提供的,API 服务使用他来匹配要更新的自行车。自行车的编号是全局唯一的,自行车与其编号一一对应,不会重复。因此,自行车的编号可以作为路径参数。当然,上架日期也不需要在更新操作中进行修改。如果有必要,可以增加更新日期属性,记录最近一次更新时间。因此,在更新自行车资源时,需要下列属性作为参数信息:

  1. 编号:reference
  2. 名称:name
  3. 价格:price
  4. 重量:weight
  5. 描述:description

小结

参数数据的设计与响应数据的设计相似,在不同的场景中,使用不同的信息表示业务实体资源。需要注意的是,参数只提供必需的数据,特别是不要提供由后端服务产生的数据。下面三个问题依然对参数数据的设计有帮助:

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

推荐阅读更多精彩内容