Restful API的設(shè)計思路

API的就是程序員的UI殷绍,和其他UI一樣,你必須仔細(xì)考慮它的用戶體驗渠羞!
Restful只是web api/Json傳輸接口通過http調(diào)斤贰,取到還要自己解。Rpc一般都是配套的次询,客戶端直接像調(diào)本地函數(shù)一樣調(diào)用(一般用在內(nèi)網(wǎng)服務(wù)間調(diào)用荧恍,可以用rpc的框架thrift)
Swagger可以用來管理你的RESTful API

使用SSL(https)來提供URL

  • 使用https可以在數(shù)據(jù)包被抓取時多一層加密
  • 即使你使用了https,黑客抓不到你具體傳輸?shù)臄?shù)據(jù)屯吊,但是可以抓到你請求的URL八脱病!因此盒卸,使用https進(jìn)行請求時骗爆,要采用POST、PUT或者HEAD的方式傳輸必要的數(shù)據(jù)

使用GET蔽介、POST摘投、PUT、DELETE這幾種請求模式

  • curl請求支持這些請求方式
  • get(select)從服務(wù)器抽取資源虹蓄;
  • post(create)在服務(wù)器創(chuàng)建一個資源犀呼;
  • put(update)在服務(wù)器更新資源;
  • delete(delete)從服務(wù)器刪除資源薇组。

在URI中體現(xiàn)資源外臂,而非動作

  • 每個網(wǎng)址代表一種資源,不能用動詞只能有名詞律胀,多用復(fù)數(shù)名詞
  • URI的設(shè)計應(yīng)該遵循可尋址性原則宋光,具有自描述性,需要在形式上給人以直覺上的關(guān)聯(lián)
  • 使用?用來過濾資源炭菌,很多人只是把?簡單的當(dāng)做是參數(shù)的傳遞罪佳,很容易造成URI過于復(fù)雜、難以理解黑低。赘艳?對應(yīng)的是一些特定條件的查詢結(jié)果或算法運(yùn)算結(jié)果。
  • ,或;可以用來表示同級資源的關(guān)系投储,有時候我們需要表示同級資源的關(guān)系時第练,可以使用,或;來進(jìn)行分割阔馋。

版本

  • 接口參數(shù)或返回值有變化
  • 邏輯處理有變化

HTTP響應(yīng)碼

下面是一些參考的狀態(tài)碼:

  • 200 OK - [GET]:服務(wù)器成功返回用戶請求的數(shù)據(jù)玛荞,該操作是冪等的(Idempotent)。
  • 201 CREATED - [POST/PUT/PATCH]:用戶新建或修改數(shù)據(jù)成功呕寝。
  • 202 Accepted - [*]:表示一個請求已經(jīng)進(jìn)入后臺排隊(異步任務(wù))
  • 204 NO CONTENT - [DELETE]:用戶刪除數(shù)據(jù)成功勋眯。
  • 400 INVALID REQUEST - [POST/PUT/PATCH]:用戶發(fā)出的請求有錯誤,服務(wù)器沒有進(jìn)行新建或修改數(shù)據(jù)的操作,該操作是冪等的客蹋。
  • 401 Unauthorized - [*]:表示用戶沒有權(quán)限(令牌塞蹭、用戶名、密碼錯誤)讶坯。
  • 403 Forbidden - [*] 表示用戶得到授權(quán)(與401錯誤相對)番电,但是訪問是被禁止的。
  • 404 NOT FOUND - [*]:用戶發(fā)出的請求針對的是不存在的記錄辆琅,服務(wù)器沒有進(jìn)行操作漱办,該操作是冪等的。
  • 406 Not Acceptable - [GET]:用戶請求的格式不可得(比如用戶請求JSON格式婉烟,但是只有XML格式)娩井。
  • 410 Gone -[GET]:用戶請求的資源被永久刪除,且不會再得到的似袁。
  • 422 Unprocesable entity - [POST/PUT/PATCH] 當(dāng)創(chuàng)建一個對象時洞辣,發(fā)生一個驗證錯誤。
  • 500 INTERNAL SERVER ERROR - [*]:服務(wù)器發(fā)生錯誤昙衅,用戶將無法判斷發(fā)出的請求是否成功扬霜。

返回值結(jié)構(gòu)

使用JSON進(jìn)行返回:

  • JSON可以很好的被很多程序支持,javascript的ajax可以直接將JSON轉(zhuǎn)換為對象绒尊。

  • JSON的格式在容量上比xml小很多畜挥,可以減低寬帶占用,提高傳輸效率婴谱。

  • 字段的合理返回蟹但,數(shù)據(jù)的包裹。因為返回值中谭羔,我們常常要對數(shù)據(jù)進(jìn)行區(qū)分分組华糖,或者按照從屬關(guān)系打包,所以瘟裸,我們再返回時客叉,最好有包裹的思想,把數(shù)據(jù)存放在不同的包裹中進(jìn)行返回话告。

      {
          "error_code" : ,
          "data" : {
               "user_id" : ,
               "username" : "admin"
           },
          "server_time": 14939939
      }
    

鑒權(quán)

  • 通行的是使用OAuth的方式兼搏,通過AccessToken來進(jìn)行身份管理

自我保護(hù)能力

  • 即使使用的人沒仔細(xì)看API文檔隨便亂用也不會導(dǎo)致系統(tǒng)出問題,這種案例非常的多沙郭,例如對外提供了一個批量查詢接口佛呻,結(jié)果用戶一下傳了一個里面有上千個用戶id的數(shù)組,查詢一下直接把內(nèi)存耗光病线,像這種情況下不能怪使用的人吓著,而應(yīng)該怪實現(xiàn)API的這一端的保護(hù)做的不夠好鲤嫡,按照這樣的標(biāo)準(zhǔn)去看,會發(fā)現(xiàn)開源的很多東西的API都不太合格绑莺;
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末暖眼,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子纺裁,更是在濱河造成了極大的恐慌诫肠,老刑警劉巖,帶你破解...
    沈念sama閱讀 216,544評論 6 501
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件欺缘,死亡現(xiàn)場離奇詭異区赵,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)浪南,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,430評論 3 392
  • 文/潘曉璐 我一進(jìn)店門笼才,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人络凿,你說我怎么就攤上這事骡送。” “怎么了絮记?”我有些...
    開封第一講書人閱讀 162,764評論 0 353
  • 文/不壞的土叔 我叫張陵摔踱,是天一觀的道長。 經(jīng)常有香客問我怨愤,道長派敷,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,193評論 1 292
  • 正文 為了忘掉前任撰洗,我火速辦了婚禮篮愉,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘差导。我一直安慰自己试躏,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 67,216評論 6 388
  • 文/花漫 我一把揭開白布设褐。 她就那樣靜靜地躺著颠蕴,像睡著了一般。 火紅的嫁衣襯著肌膚如雪助析。 梳的紋絲不亂的頭發(fā)上犀被,一...
    開封第一講書人閱讀 51,182評論 1 299
  • 那天,我揣著相機(jī)與錄音外冀,去河邊找鬼寡键。 笑死,一個胖子當(dāng)著我的面吹牛锥惋,可吹牛的內(nèi)容都是我干的昌腰。 我是一名探鬼主播,決...
    沈念sama閱讀 40,063評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼膀跌,長吁一口氣:“原來是場噩夢啊……” “哼遭商!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起捅伤,我...
    開封第一講書人閱讀 38,917評論 0 274
  • 序言:老撾萬榮一對情侶失蹤劫流,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后丛忆,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體祠汇,經(jīng)...
    沈念sama閱讀 45,329評論 1 310
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,543評論 2 332
  • 正文 我和宋清朗相戀三年熄诡,在試婚紗的時候發(fā)現(xiàn)自己被綠了可很。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 39,722評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡凰浮,死狀恐怖我抠,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情袜茧,我是刑警寧澤菜拓,帶...
    沈念sama閱讀 35,425評論 5 343
  • 正文 年R本政府宣布,位于F島的核電站笛厦,受9級特大地震影響纳鼎,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜裳凸,卻給世界環(huán)境...
    茶點故事閱讀 41,019評論 3 326
  • 文/蒙蒙 一贱鄙、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧姨谷,春花似錦贰逾、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,671評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至践叠,卻和暖如春言缤,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背禁灼。 一陣腳步聲響...
    開封第一講書人閱讀 32,825評論 1 269
  • 我被黑心中介騙來泰國打工管挟, 沒想到剛下飛機(jī)就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人弄捕。 一個月前我還...
    沈念sama閱讀 47,729評論 2 368
  • 正文 我出身青樓僻孝,卻偏偏與公主長得像导帝,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子穿铆,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 44,614評論 2 353

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