API 文檔編寫規(guī)范(URL篇)

風(fēng)格

POST

協(xié)議 + 域名/IP + 端口號(hào) + /api + /項(xiàng)目名 + /一級(jí)資源 + /n級(jí)資源 + 動(dòng)作
如:http://127.0.0.1:6666/api/user/detail/get

RESTful

協(xié)議 + 域名/IP + 端口號(hào) + /api + /項(xiàng)目名 + /一級(jí)資源 + /n級(jí)資源
如:GET http://127.0.0.1:6666/api/user/detail


URL參數(shù)

統(tǒng)一使用 & 連接鍵值對(duì)的方式
如:http://127.0.0.1:6666/api/user/get?name_user=Tony&sex_user=1

方法 描述
HEAD 可以對(duì)任何資源發(fā)出請(qǐng)求针饥,以獲取HTTP頭信息
GET 查找資源
POST 創(chuàng)建資源
PATCH 替換資源的部分信息
PUT 替換資源的全部信息厂抽,要求請(qǐng)求信息是完整的。若某字段不傳遞丁眼,則賦予默認(rèn)值
DELETE 刪除資源

注意點(diǎn)

版本號(hào)不應(yīng)寫在URL中

不同版本筷凤,可以理解成同一種資源的不同表現(xiàn)形式,所以應(yīng)該采用同一個(gè)URL苞七。版本號(hào)可以在HTTP請(qǐng)求頭信息的 Accept 字段中進(jìn)行區(qū)分

Accept: vnd.example-com.foo+json; version=1.0
Accept: vnd.example-com.foo+json; version=1.1
Accept: vnd.example-com.foo+json; version=2.0

RESTful URL 只出現(xiàn)名詞

如果某些動(dòng)作是HTTP動(dòng)詞表示不了的藐守,你就應(yīng)該把動(dòng)作做成一種資源。比如網(wǎng)上匯款蹂风,從賬戶1向賬戶2匯款500元卢厂,錯(cuò)誤的URI是:
POST /accounts/1/transfer/500/to/2

正確的寫法是把動(dòng)詞transfer改成名詞transaction,資源不能是動(dòng)詞惠啄,但是可以是一種服務(wù):
POST /transaction

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末慎恒,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子撵渡,更是在濱河造成了極大的恐慌融柬,老刑警劉巖,帶你破解...
    沈念sama閱讀 211,290評(píng)論 6 491
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件趋距,死亡現(xiàn)場(chǎng)離奇詭異粒氧,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)棚品,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,107評(píng)論 2 385
  • 文/潘曉璐 我一進(jìn)店門靠欢,熙熙樓的掌柜王于貴愁眉苦臉地迎上來廊敌,“玉大人铜跑,你說我怎么就攤上這事÷獬海” “怎么了锅纺?”我有些...
    開封第一講書人閱讀 156,872評(píng)論 0 347
  • 文/不壞的土叔 我叫張陵礼华,是天一觀的道長(zhǎng)渊涝。 經(jīng)常有香客問我,道長(zhǎng)蜗细,這世上最難降的妖魔是什么护锤? 我笑而不...
    開封第一講書人閱讀 56,415評(píng)論 1 283
  • 正文 為了忘掉前任官地,我火速辦了婚禮,結(jié)果婚禮上烙懦,老公的妹妹穿的比我還像新娘驱入。我一直安慰自己,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,453評(píng)論 6 385
  • 文/花漫 我一把揭開白布亏较。 她就那樣靜靜地躺著莺褒,像睡著了一般。 火紅的嫁衣襯著肌膚如雪雪情。 梳的紋絲不亂的頭發(fā)上遵岩,一...
    開封第一講書人閱讀 49,784評(píng)論 1 290
  • 那天,我揣著相機(jī)與錄音巡通,去河邊找鬼尘执。 笑死,一個(gè)胖子當(dāng)著我的面吹牛宴凉,可吹牛的內(nèi)容都是我干的正卧。 我是一名探鬼主播,決...
    沈念sama閱讀 38,927評(píng)論 3 406
  • 文/蒼蘭香墨 我猛地睜開眼跪解,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼炉旷!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起叉讥,我...
    開封第一講書人閱讀 37,691評(píng)論 0 266
  • 序言:老撾萬榮一對(duì)情侶失蹤窘行,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后图仓,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體罐盔,經(jīng)...
    沈念sama閱讀 44,137評(píng)論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,472評(píng)論 2 326
  • 正文 我和宋清朗相戀三年救崔,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了惶看。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 38,622評(píng)論 1 340
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡六孵,死狀恐怖纬黎,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情劫窒,我是刑警寧澤本今,帶...
    沈念sama閱讀 34,289評(píng)論 4 329
  • 正文 年R本政府宣布,位于F島的核電站主巍,受9級(jí)特大地震影響冠息,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜孕索,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,887評(píng)論 3 312
  • 文/蒙蒙 一逛艰、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧搞旭,春花似錦散怖、人聲如沸唐断。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,741評(píng)論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽脸甘。三九已至,卻和暖如春偏灿,著一層夾襖步出監(jiān)牢的瞬間丹诀,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,977評(píng)論 1 265
  • 我被黑心中介騙來泰國(guó)打工翁垂, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留铆遭,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 46,316評(píng)論 2 360
  • 正文 我出身青樓沿猜,卻偏偏與公主長(zhǎng)得像枚荣,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子啼肩,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,490評(píng)論 2 348

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