API 入门 (24) 设计 API 的数据——业务实体

在前面的设计过程中,我们已经找出了两个主要的业务实体:自行车和目录,并把他们转换为可以操作的资源。在 API 的消费者和提供者的交互过程中,业务实体的信息(作为请求的参数和响应的返回值)在双方之间进行传递。

我们的下一个小目标就是如何设计 API 的数据。本文重点介绍一个如何设计业务实体的属性的方法。

列出属性

首先,我们要写出一个业务实体的属性,并为每一个属性定义一个用户友好的名字。以 自行车 业务实体为例:

  • 编号:reference
  • 名称:name
  • 价格:price
  • 重量:weight
  • 上架日期:dateAdded
  • 描述:description

为了保证坚持用户为中心的原则(千万要牢记!),在写业务实体的属性时,可以问问下面的问题:

  • 用户理解每一个属性吗?
  • 这些属性都是业务相关的吗?
  • 每一个属性对客户都有用吗?

属性的类型

在列出属性后,我们还有指定属性的数据类型。在为属性选择数据类型时,建议使用可移植的基本数据类型,可以兼容不同的编程语言。常见的基本数据类型有:string,number,date 和 boolean.

现在为 自行车 业务实体添加类型:

  • 编号:reference|string
  • 名称:name|string
  • 价格:price|number
  • 重量:weight|number
  • 上架日期:dateAdded|date
  • 描述:description|string

属性的必要性

在一些场景下,某个业务实体的属性必须存在,才能达成 API 的目标;而在另一些场景下,这个属性不出现,也不影响用户的使用和具体实现。对于 API 的每一个目标,设计者,消费者和研发人员,都有十分清楚业务实体的属性是否是必要的。

现在为 自行车 业务实体添加必要性:

  • 编号:reference|string|required
  • 名称:name|string|required
  • 价格:price|number|required
  • 重量:weight|number|optional
  • 上架日期:dateAdded|date|optional
  • 描述:description|string|optional

属性的描述

虽然我们要求属性的名称是用户友好的,自描述的,但是有时候很难通过一个词进行描述。这时候,我们可以添加一些额外但描述信息。

  • 编号:reference|string|required|自行车但唯一标识
  • 名称:name|string|required|
  • 价格:price|number|required|自行车单价(人民币元)
  • 重量:weight|number|optional|净重
  • 上架日期:dateAdded|date|optional|添加自行车到目录的日期
  • 描述:description|string|optional|

成果

最后,使用一张表格,对 自行车 业务实体的属性进行概括。

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

推荐阅读更多精彩内容