RestAPI設計標準栅贴?

要設計些Restful API瞳秽,試圖看看業(yè)界對錯誤返回有沒有標準√湎兀看了幾個:
https://developers.douban.com/wiki/?title=api_v2
https://github.com/FanfouAPI/FanFouAPIDoc/wiki
https://developer.github.com/v3/
http://open.weibo.com/wiki/API%E6%96%87%E6%A1%A3_V2
https://dev.twitter.com/rest/public/search

douban

{
 "msg":"uri_not_found", 
 "code":1001, 
 "request":"GET \/v2\/photo\/132"
}

fanfou

{
 "request":"/account/show.json", 
 "error":"參數錯誤"
}

twitter

{"error":"Sorry, your query is too complex. Please reduce complexity and try again."}

github

{ 
 "message": "Bad credentials", 
 "documentation_url": "https://developer.github.com/v3"
}

weibo

{   
 "request" : "/statuses/home_timeline.json",    
 "error_code" : "20502",    
 "error" : "Need you follow uid."
}

結論:沒有統(tǒng)一標準材原。大家隨便玩兒吧。

大多數使用了error表示錯誤信息谭羔,有的用error_code表示錯誤編號华糖。error_code這個東西,某些程度上可以幫助多語言化瘟裸。但是也會使得api很累贅客叉,而且……編號也很麻煩,編了號還得查表话告。直接用英文的error信息是比較方便的兼搏。多語言時就翻譯一下。
這樣說來沙郭。我選擇twitter的表達方式佛呻。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市病线,隨后出現的幾起案子吓著,更是在濱河造成了極大的恐慌鲤嫡,老刑警劉巖,帶你破解...
    沈念sama閱讀 221,406評論 6 515
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件绑莺,死亡現場離奇詭異暖眼,居然都是意外死亡,警方通過查閱死者的電腦和手機纺裁,發(fā)現死者居然都...
    沈念sama閱讀 94,395評論 3 398
  • 文/潘曉璐 我一進店門诫肠,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人欺缘,你說我怎么就攤上這事栋豫。” “怎么了谚殊?”我有些...
    開封第一講書人閱讀 167,815評論 0 360
  • 文/不壞的土叔 我叫張陵丧鸯,是天一觀的道長。 經常有香客問我络凿,道長骡送,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 59,537評論 1 296
  • 正文 為了忘掉前任絮记,我火速辦了婚禮摔踱,結果婚禮上,老公的妹妹穿的比我還像新娘怨愤。我一直安慰自己派敷,他們只是感情好,可當我...
    茶點故事閱讀 68,536評論 6 397
  • 文/花漫 我一把揭開白布撰洗。 她就那樣靜靜地躺著篮愉,像睡著了一般。 火紅的嫁衣襯著肌膚如雪差导。 梳的紋絲不亂的頭發(fā)上试躏,一...
    開封第一講書人閱讀 52,184評論 1 308
  • 那天,我揣著相機與錄音设褐,去河邊找鬼颠蕴。 笑死,一個胖子當著我的面吹牛助析,可吹牛的內容都是我干的犀被。 我是一名探鬼主播,決...
    沈念sama閱讀 40,776評論 3 421
  • 文/蒼蘭香墨 我猛地睜開眼外冀,長吁一口氣:“原來是場噩夢啊……” “哼寡键!你這毒婦竟也來了?” 一聲冷哼從身側響起雪隧,我...
    開封第一講書人閱讀 39,668評論 0 276
  • 序言:老撾萬榮一對情侶失蹤西轩,失蹤者是張志新(化名)和其女友劉穎员舵,沒想到半個月后,有當地人在樹林里發(fā)現了一具尸體遭商,經...
    沈念sama閱讀 46,212評論 1 319
  • 正文 獨居荒郊野嶺守林人離奇死亡固灵,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 38,299評論 3 340
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現自己被綠了劫流。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 40,438評論 1 352
  • 序言:一個原本活蹦亂跳的男人離奇死亡丛忆,死狀恐怖祠汇,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情熄诡,我是刑警寧澤可很,帶...
    沈念sama閱讀 36,128評論 5 349
  • 正文 年R本政府宣布,位于F島的核電站凰浮,受9級特大地震影響我抠,放射性物質發(fā)生泄漏。R本人自食惡果不足惜袜茧,卻給世界環(huán)境...
    茶點故事閱讀 41,807評論 3 333
  • 文/蒙蒙 一菜拓、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧笛厦,春花似錦纳鼎、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,279評論 0 24
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至姨谷,卻和暖如春逗宁,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背梦湘。 一陣腳步聲響...
    開封第一講書人閱讀 33,395評論 1 272
  • 我被黑心中介騙來泰國打工瞎颗, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人践叠。 一個月前我還...
    沈念sama閱讀 48,827評論 3 376
  • 正文 我出身青樓言缤,卻偏偏與公主長得像,于是被迫代替她去往敵國和親禁灼。 傳聞我的和親對象是個殘疾皇子管挟,可洞房花燭夜當晚...
    茶點故事閱讀 45,446評論 2 359

推薦閱讀更多精彩內容

  • afinalAfinal是一個android的ioc,orm框架 https://github.com/yangf...
    passiontim閱讀 15,435評論 2 45
  • 1.圖片瀏覽控件MWPhotoBrowser 實現了一個照片瀏覽器類似 iOS 自帶的相冊應用弄捕,可顯示來自手機的圖...
    萬忍閱讀 1,501評論 0 6
  • 關于數據的緩存僻孝,網上的資料和博客很多导帝,總的來說五種方法,plist穿铆,寫文件您单,NSUserDefaults,FMDB...
    小多多閱讀 811評論 1 4
  • 接到朋友電話,很火大葵萎,說她讀一年級的兒子被同桌的男生打了府寒,雖然沒有明顯的外傷,但兒子現在都不敢去上學了悦陋。 朋友強壓...
    探索者Doll閱讀 330評論 0 1