在上一篇文章中狐援,我們設(shè)計了響應(yīng)的數(shù)據(jù)結(jié)構(gòu)钢坦。本文繼續(xù)介紹如何設(shè)計參數(shù)的數(shù)據(jù)結(jié)構(gòu)。
在添加啥酱、更新一個自行車資源時爹凹,需要將自行車的信息作為參數(shù)傳遞給 API 的操作。那么懈涛,這個參數(shù)需要包含哪些信息呢逛万?
我們先回顧一下自行車的屬性信息,再根據(jù)具體的操作進(jìn)行分析批钠。
自行車的屬性:
- 編號:reference
- 名稱:name
- 價格:price
- 重量:weight
- 上架日期:dateAdded
- 描述:description
添加自行車
在添加一個新的自行車資源時宇植,自行車的編號屬性,是由后端服務(wù)根據(jù)業(yè)務(wù)規(guī)則生成的埋心,不需要管理員提供指郁。再來看看上架日期。上架日期應(yīng)該等同于管理員添加自行車時的日期和時間拷呆,也不需要管理員手動添加闲坎,由后端服務(wù)自動添加即可。因此茬斧,在添加自行車資源時腰懂,需要下列屬性作為參數(shù)信息:
- 名稱:name
- 價格:price
- 重量:weight
- 描述:description
更新自行車
在更新一個自行車資源時,自行車的編號是需要提供的项秉,API 服務(wù)使用他來匹配要更新的自行車绣溜。自行車的編號是全局唯一的,自行車與其編號一一對應(yīng)娄蔼,不會重復(fù)怖喻。因此底哗,自行車的編號可以作為路徑參數(shù)。當(dāng)然锚沸,上架日期也不需要在更新操作中進(jìn)行修改跋选。如果有必要,可以增加更新日期屬性哗蜈,記錄最近一次更新時間前标。因此,在更新自行車資源時恬叹,需要下列屬性作為參數(shù)信息:
- 編號:reference
- 名稱:name
- 價格:price
- 重量:weight
- 描述: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è)計有幫助:
- 所有屬性都與客戶業(yè)務(wù)相關(guān)嗎?
- 所有屬性都是客戶需要的嗎明肮?
- 客戶理解所有屬性的含義嗎菱农?