API 入門 (26) 設(shè)計 API 的數(shù)據(jù)——查詢參數(shù)數(shù)據(jù)

上一篇文章中狐援,我們設(shè)計了響應(yīng)的數(shù)據(jù)結(jié)構(gòu)钢坦。本文繼續(xù)介紹如何設(shè)計參數(shù)的數(shù)據(jù)結(jié)構(gòu)。

在添加啥酱、更新一個自行車資源時爹凹,需要將自行車的信息作為參數(shù)傳遞給 API 的操作。那么懈涛,這個參數(shù)需要包含哪些信息呢逛万?

我們先回顧一下自行車的屬性信息,再根據(jù)具體的操作進(jìn)行分析批钠。

自行車的屬性:

  1. 編號:reference
  2. 名稱:name
  3. 價格:price
  4. 重量:weight
  5. 上架日期:dateAdded
  6. 描述:description

添加自行車

在添加一個新的自行車資源時宇植,自行車的編號屬性,是由后端服務(wù)根據(jù)業(yè)務(wù)規(guī)則生成的埋心,不需要管理員提供指郁。再來看看上架日期。上架日期應(yīng)該等同于管理員添加自行車時的日期和時間拷呆,也不需要管理員手動添加闲坎,由后端服務(wù)自動添加即可。因此茬斧,在添加自行車資源時腰懂,需要下列屬性作為參數(shù)信息:

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

更新自行車

在更新一個自行車資源時,自行車的編號是需要提供的项秉,API 服務(wù)使用他來匹配要更新的自行車绣溜。自行車的編號是全局唯一的,自行車與其編號一一對應(yīng)娄蔼,不會重復(fù)怖喻。因此底哗,自行車的編號可以作為路徑參數(shù)。當(dāng)然锚沸,上架日期也不需要在更新操作中進(jìn)行修改跋选。如果有必要,可以增加更新日期屬性哗蜈,記錄最近一次更新時間前标。因此,在更新自行車資源時恬叹,需要下列屬性作為參數(shù)信息:

  1. 編號:reference
  2. 名稱:name
  3. 價格:price
  4. 重量:weight
  5. 描述:description

小結(jié)

參數(shù)數(shù)據(jù)的設(shè)計與響應(yīng)數(shù)據(jù)的設(shè)計相似候生,在不同的場景中,使用不同的信息表示業(yè)務(wù)實體資源绽昼。需要注意的是,參數(shù)只提供必需的數(shù)據(jù)须蜗,特別是不要提供由后端服務(wù)產(chǎn)生的數(shù)據(jù)硅确。下面三個問題依然對參數(shù)數(shù)據(jù)的設(shè)計有幫助:

  1. 所有屬性都與客戶業(yè)務(wù)相關(guān)嗎?
  2. 所有屬性都是客戶需要的嗎明肮?
  3. 客戶理解所有屬性的含義嗎菱农?
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市柿估,隨后出現(xiàn)的幾起案子循未,更是在濱河造成了極大的恐慌,老刑警劉巖秫舌,帶你破解...
    沈念sama閱讀 217,277評論 6 503
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件的妖,死亡現(xiàn)場離奇詭異,居然都是意外死亡足陨,警方通過查閱死者的電腦和手機嫂粟,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,689評論 3 393
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來墨缘,“玉大人星虹,你說我怎么就攤上這事∧魉希” “怎么了宽涌?”我有些...
    開封第一講書人閱讀 163,624評論 0 353
  • 文/不壞的土叔 我叫張陵,是天一觀的道長蝶棋。 經(jīng)常有香客問我卸亮,道長,這世上最難降的妖魔是什么嚼松? 我笑而不...
    開封第一講書人閱讀 58,356評論 1 293
  • 正文 為了忘掉前任嫡良,我火速辦了婚禮锰扶,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘寝受。我一直安慰自己坷牛,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 67,402評論 6 392
  • 文/花漫 我一把揭開白布很澄。 她就那樣靜靜地躺著京闰,像睡著了一般。 火紅的嫁衣襯著肌膚如雪甩苛。 梳的紋絲不亂的頭發(fā)上蹂楣,一...
    開封第一講書人閱讀 51,292評論 1 301
  • 那天,我揣著相機與錄音讯蒲,去河邊找鬼痊土。 笑死,一個胖子當(dāng)著我的面吹牛墨林,可吹牛的內(nèi)容都是我干的赁酝。 我是一名探鬼主播,決...
    沈念sama閱讀 40,135評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼旭等,長吁一口氣:“原來是場噩夢啊……” “哼酌呆!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起搔耕,我...
    開封第一講書人閱讀 38,992評論 0 275
  • 序言:老撾萬榮一對情侶失蹤隙袁,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后弃榨,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體菩收,經(jīng)...
    沈念sama閱讀 45,429評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,636評論 3 334
  • 正文 我和宋清朗相戀三年惭墓,在試婚紗的時候發(fā)現(xiàn)自己被綠了坛梁。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 39,785評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡腊凶,死狀恐怖划咐,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情钧萍,我是刑警寧澤褐缠,帶...
    沈念sama閱讀 35,492評論 5 345
  • 正文 年R本政府宣布,位于F島的核電站风瘦,受9級特大地震影響队魏,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,092評論 3 328
  • 文/蒙蒙 一胡桨、第九天 我趴在偏房一處隱蔽的房頂上張望官帘。 院中可真熱鬧,春花似錦昧谊、人聲如沸刽虹。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,723評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽涌哲。三九已至,卻和暖如春尚镰,著一層夾襖步出監(jiān)牢的瞬間阀圾,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 32,858評論 1 269
  • 我被黑心中介騙來泰國打工狗唉, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留初烘,地道東北人。 一個月前我還...
    沈念sama閱讀 47,891評論 2 370
  • 正文 我出身青樓分俯,卻偏偏與公主長得像账月,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子澳迫,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 44,713評論 2 354

推薦閱讀更多精彩內(nèi)容