用node建立web服務(wù)(八)確定接口標準

提交的接口

url 的格式

【method】/api/:moduleId/:actionId/:dataId
  • method
    這個沒啥要求亥宿,不需要 body 就用 get道逗,需要 body 就用 post。
    可以支持其他的瞎暑,只是沒啥作用彤敛。

  • moduleId
    模塊ID,原來想直接用serviceId的了赌,但是發(fā)現(xiàn)這樣做的話數(shù)量太多臊泌,容易懵逼,所以還是用一個模塊來做一個分組揍拆,這樣API接口的數(shù)量,看起來就不會太多茶凳。

  • actionId
    動作ID嫂拴,類似于 RESTful 里面的get、post贮喧、put筒狠、delete等,
    也類似于ASP.net MVC 里面的action箱沦。
    沒有使用 RESTful 的方式辩恼,是因為總感覺靈活度不夠。這里使用ID(也可以是其他標志)可以更靈活一些,擺脫一些束縛灶伊。

  • dataId
    記錄的主鍵的值疆前,用于獲取(get)記錄聘萨,刪除記錄竹椒,修改記錄等。
    可以作為一個資源的唯一標志米辐。

舉例

【post】/api/100/10  // 添加
【post】/api/100/20/1  // 修改
【get】/api/100/30/1  // 刪除
【get】/api/100/40/1  // 獲取記錄(model)
【post】/api/100/50/1  // 分頁+查詢胸完,獲取記錄集
【post/get】/api/100/60/1  // 獲取記錄,可以查詢

如果感覺“魔數(shù)”不好看的話翘贮,可以改成單詞:

【post】/api/user/10-add  // 添加
【post】/api/user/20-update/1  // 修改
【get】/api/user/30-delete/1  // 刪除
【get】/api/user/40-get/1  // 獲取記錄(model)
【post】/api/user/50-pager  // 分頁+查詢赊窥,獲取記錄集
【post/get】/api/user/60-all  // 獲取記錄,可以查詢

actionId狸页,也采用數(shù)字锨能,是因為懶得起名字了,起名困難癥呀肴捉。

body的格式

這個根據(jù)申請的類型有所區(qū)別腹侣。其中獲取、刪除只有g(shù)et齿穗,沒有post方式傲隶,也就是沒有body的格式。

添加窃页、修改

按照需求設(shè)置字段名和字段值

{
  name:"這是名稱",
  age:"18"
}
表單數(shù)據(jù)

分頁和查詢

{
  pager: {
    pagerIndex:2,
    pagerSize:20
  },
  query: {
     name: [401, "jyk"]
  },
  useCount: false
}
分頁 + 查詢
  • pager
    提交兩個參數(shù)跺株,一個是第幾頁的數(shù)據(jù),一個是一頁多少條記錄脖卖。

  • query
    提交查詢條件

  • useCount
    是否需要統(tǒng)計總記錄數(shù)乒省。這個是出于性能的考慮。

接收的格式

還沒想好具體的格式畦木,先弄個code吧袖扛,似乎大家都是這么弄的。
這個code僅僅表示業(yè)務(wù)邏輯十籍,和其他無關(guān)蛆封。
其他的嘛,model表示一條記錄勾栗,list表示列表惨篱,pager表示分頁信息。
其他待定围俘,也許應(yīng)該加一個msg砸讳,出錯的時候放描述錯誤信息琢融。

添加

返回新記錄的ID值

新記錄ID

修改和刪除

返回影響的行數(shù),如果為 1 簿寂,說明改了一條(或者刪除一條)漾抬,如果為 0 說明沒找到記錄。

修改和刪除

獲取

返回model

model

查詢

返回記錄集合

獲取全部數(shù)據(jù)

分頁

返回記錄集合以及分頁信息

分頁獲取記錄
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末陶耍,一起剝皮案震驚了整個濱河市奋蔚,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌烈钞,老刑警劉巖泊碑,帶你破解...
    沈念sama閱讀 218,607評論 6 507
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異毯欣,居然都是意外死亡馒过,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,239評論 3 395
  • 文/潘曉璐 我一進店門酗钞,熙熙樓的掌柜王于貴愁眉苦臉地迎上來腹忽,“玉大人,你說我怎么就攤上這事砚作【阶啵” “怎么了?”我有些...
    開封第一講書人閱讀 164,960評論 0 355
  • 文/不壞的土叔 我叫張陵葫录,是天一觀的道長着裹。 經(jīng)常有香客問我,道長米同,這世上最難降的妖魔是什么骇扇? 我笑而不...
    開封第一講書人閱讀 58,750評論 1 294
  • 正文 為了忘掉前任,我火速辦了婚禮面粮,結(jié)果婚禮上少孝,老公的妹妹穿的比我還像新娘。我一直安慰自己熬苍,他們只是感情好稍走,可當我...
    茶點故事閱讀 67,764評論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著柴底,像睡著了一般钱磅。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上似枕,一...
    開封第一講書人閱讀 51,604評論 1 305
  • 那天,我揣著相機與錄音年柠,去河邊找鬼凿歼。 笑死褪迟,一個胖子當著我的面吹牛,可吹牛的內(nèi)容都是我干的答憔。 我是一名探鬼主播味赃,決...
    沈念sama閱讀 40,347評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼虐拓!你這毒婦竟也來了心俗?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,253評論 0 276
  • 序言:老撾萬榮一對情侶失蹤蓉驹,失蹤者是張志新(化名)和其女友劉穎城榛,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體态兴,經(jīng)...
    沈念sama閱讀 45,702評論 1 315
  • 正文 獨居荒郊野嶺守林人離奇死亡狠持,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,893評論 3 336
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了瞻润。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片喘垂。...
    茶點故事閱讀 40,015評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖绍撞,靈堂內(nèi)的尸體忽然破棺而出正勒,到底是詐尸還是另有隱情,我是刑警寧澤傻铣,帶...
    沈念sama閱讀 35,734評論 5 346
  • 正文 年R本政府宣布章贞,位于F島的核電站,受9級特大地震影響矾柜,放射性物質(zhì)發(fā)生泄漏阱驾。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,352評論 3 330
  • 文/蒙蒙 一怪蔑、第九天 我趴在偏房一處隱蔽的房頂上張望里覆。 院中可真熱鬧耍鬓,春花似錦熙掺、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,934評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽隧甚。三九已至,卻和暖如春渡冻,著一層夾襖步出監(jiān)牢的瞬間戚扳,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,052評論 1 270
  • 我被黑心中介騙來泰國打工族吻, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留帽借,地道東北人珠增。 一個月前我還...
    沈念sama閱讀 48,216評論 3 371
  • 正文 我出身青樓,卻偏偏與公主長得像砍艾,于是被迫代替她去往敵國和親蒂教。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 44,969評論 2 355

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