一、Api資源分類(lèi)
根據(jù)使用對(duì)象以及應(yīng)用場(chǎng)景不同，我們把Api劃分為?免費(fèi)資源，移動(dòng)端資源、聯(lián)合資源。
1、Free 免費(fèi)資源
地址：/free/****
描述：該類(lèi)資源主要是用于不涉密公共基礎(chǔ)數(shù)據(jù)服務(wù)，在開(kāi)發(fā)前端業(yè)務(wù)組件時(shí)常會(huì)使用到該類(lèi)數(shù)據(jù)服務(wù)。
2、Unity?聯(lián)合資源
地址：/unity/****
描述：主要提供給web?與 client?使用，該類(lèi)資源需要進(jìn)行權(quán)限認(rèn)證。
3、 Mobile?移動(dòng)資源
地址：/mobile/****
描述：主要提供給移動(dòng)端使用，該類(lèi)資源也需要進(jìn)行權(quán)限認(rèn)證。
二、命名規(guī)范
1、使用英文全小寫(xiě)，組合詞使用“-”連接，盡量不要用英文簡(jiǎn)寫(xiě)或中文拼音等
三、地址規(guī)范
1、語(yǔ)意須簡(jiǎn)要、清晰。所表達(dá)的意思要逐級(jí)遞進(jìn)
2、對(duì)于語(yǔ)意不明確的可采用*****?state=cache?來(lái)修飾
四、地址約定
4.1?常見(jiàn)場(chǎng)景地址約定設(shè)計(jì)
1、分頁(yè)查詢
xxxx/department/page
2、條件查詢
xxxx/department/query
3、主鍵獲取
xxxx/department/{id}
4、多結(jié)果單值條件獲取
xxxx/department/list?level=2
5、tree型數(shù)據(jù)獲取
xxxx/department/tree
6、子級(jí)數(shù)據(jù)獲取
xxxx/department/child/{parentId}
7、同級(jí)數(shù)據(jù)獲取
xxx/department/siblings/{id}
8、父親數(shù)據(jù)獲取
xxx/department/parent/{childId}
9、祖先數(shù)據(jù)獲取
xxx/department/parents/{childId}
10、所有數(shù)據(jù)獲取
xxx/department/all
