restful 規(guī)范

1 api接口
    -規(guī)定了前后臺(tái)信息交互規(guī)則的url鏈接匙奴，也就是前后臺(tái)信息交互的媒介
2 接口文檔
    -可以手動(dòng)寫（公司有平臺(tái)迈螟，錄到平臺(tái)里瞒瘸，）
    -自動(dòng)生成（coreapi，swagger）
    
3 restful規(guī)范（10條盾沫，規(guī)定了這么做，公司可以不采用）
    -1 數(shù)據(jù)的安全保障，通常使用https進(jìn)行傳輸
    -2 域名（會(huì)有api標(biāo)識(shí)）
        https://api.example.com 盡量將API部署在專用域名
        https://127.0.0.0:8080/api/     API很簡(jiǎn)單
    -3 請(qǐng)求地址中帶版本摩桶，或者在請(qǐng)求頭中
        -https://127.0.0.0:8080/api/v1/
    -4 任何東西都是資源，均使用名詞表示 （盡量不要用動(dòng)詞）
        -https://api.example.com/v1/books/
        -https://api.example.com/v1/get_all_books（不符合規(guī)范）
    -5 通過請(qǐng)求方式區(qū)分不同操作
        -get獲取
        -post新增數(shù)據(jù)
        -put/patch：patch是局部更新帽揪，put是全部（基本上更新都用put）
        -delete：刪除
    -6 在請(qǐng)求路徑中帶過濾
        https://api.example.com/v1/?name='金'&order=asc
        https://api.example.com/v1/name?sortby=name&order=asc
            
    -7 返回?cái)?shù)據(jù)中帶狀態(tài)碼
        -http請(qǐng)求的狀態(tài)碼（2,3,4,5）
        -返回的json格式中到狀態(tài)碼（標(biāo)志當(dāng)次請(qǐng)求成功或失斚跚濉）
    -8 返回?cái)?shù)據(jù)中帶錯(cuò)誤信息
        -錯(cuò)誤處理，應(yīng)返回錯(cuò)誤信息转晰，error當(dāng)做key
        
    -9 對(duì)不同操作芦拿，返回?cái)?shù)據(jù)符合如下規(guī)范（這只是規(guī)范）
        GET /books：返回資源對(duì)象的列表（數(shù)組）[{},{},{}]
        GET /books/1：返回單個(gè)資源對(duì)象    {}
        POST /books：返回新生成的資源對(duì)象  {新增的書}
        PUT /books/1：返回完整的資源對(duì)象   {返回修改后的}
        PATCH /books/1： 返回完整的資源對(duì)象  {返回修改后的}
        DELETE /books/1：  返回一個(gè)空文檔   
        
        {status:100,msg:查詢成功,data:null}
        
    -10 返回結(jié)果中帶連接
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 人面猴
    序言：七十年代末，一起剝皮案震驚了整個(gè)濱河市查邢，隨后出現(xiàn)的幾起案子蔗崎，更是在濱河造成了極大的恐慌，老刑警劉巖扰藕，帶你破解...
    沈念sama閱讀 221,576評(píng)論 6贊 515
  • 死咒
    序言：濱河連續(xù)發(fā)生了三起死亡事件缓苛，死亡現(xiàn)場(chǎng)離奇詭異，居然都是意外死亡实胸，警方通過查閱死者的電腦和手機(jī)他嫡，發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,515評(píng)論 3贊 399
  • 救了他兩次的神仙讓他今天三更去死
    文/潘曉璐 我一進(jìn)店門，熙熙樓的掌柜王于貴愁眉苦臉地迎上來庐完，“玉大人钢属，你說我怎么就攤上這事∶徘” “怎么了淆党？”我有些...
    開封第一講書人閱讀 168,017評(píng)論 0贊 360
  • 道士緝兇錄：失蹤的賣姜人
    文/不壞的土叔 我叫張陵，是天一觀的道長讶凉。 經(jīng)常有香客問我染乌，道長，這世上最難降的妖魔是什么懂讯？ 我笑而不...
    開封第一講書人閱讀 59,626評(píng)論 1贊 296
  • ?港島之戀（遺憾婚禮）
    正文 為了忘掉前任荷憋，我火速辦了婚禮，結(jié)果婚禮上褐望，老公的妹妹穿的比我還像新娘勒庄。我一直安慰自己串前，他們只是感情好，可當(dāng)我...
    茶點(diǎn)故事閱讀 68,625評(píng)論 6贊 397
  • 惡毒庶女頂嫁案：這布局不是一般人想出來的
    文/花漫 我一把揭開白布实蔽。 她就那樣靜靜地躺著荡碾，像睡著了一般。 火紅的嫁衣襯著肌膚如雪局装。 梳的紋絲不亂的頭發(fā)上坛吁，一...
    開封第一講書人閱讀 52,255評(píng)論 1贊 308
  • 城市分裂傳說
    那天，我揣著相機(jī)與錄音铐尚，去河邊找鬼拨脉。 笑死，一個(gè)胖子當(dāng)著我的面吹牛塑径，可吹牛的內(nèi)容都是我干的女坑。 我是一名探鬼主播填具，決...
    沈念sama閱讀 40,825評(píng)論 3贊 421
  • 雙鴛鴦連環(huán)套：你想象不到人心有多黑
    文/蒼蘭香墨 我猛地睜開眼统舀，長吁一口氣：“原來是場(chǎng)噩夢(mèng)啊……” “哼！你這毒婦竟也來了劳景？” 一聲冷哼從身側(cè)響起誉简，我...
    開封第一講書人閱讀 39,729評(píng)論 0贊 276
  • 萬榮殺人案實(shí)錄
    序言：老撾萬榮一對(duì)情侶失蹤，失蹤者是張志新（化名）和其女友劉穎盟广，沒想到半個(gè)月后闷串，有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體，經(jīng)...
    沈念sama閱讀 46,271評(píng)論 1贊 320
  • ?護(hù)林員之死
    正文 獨(dú)居荒郊野嶺守林人離奇死亡筋量，尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,363評(píng)論 3贊 340
  • ?白月光啟示錄
    正文 我和宋清朗相戀三年烹吵，在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片桨武。...
    茶點(diǎn)故事閱讀 40,498評(píng)論 1贊 352
  • 活死人
    序言：一個(gè)原本活蹦亂跳的男人離奇死亡肋拔，死狀恐怖，靈堂內(nèi)的尸體忽然破棺而出呀酸，到底是詐尸還是另有隱情凉蜂，我是刑警寧澤，帶...
    沈念sama閱讀 36,183評(píng)論 5贊 350
  • ?日本核電站爆炸內(nèi)幕
    正文 年R本政府宣布性誉，位于F島的核電站窿吩，受9級(jí)特大地震影響，放射性物質(zhì)發(fā)生泄漏错览。R本人自食惡果不足惜纫雁，卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,867評(píng)論 3贊 333
  • 男人毒藥：我在死后第九天來索命
    文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望倾哺。 院中可真熱鬧轧邪，春花似錦携冤、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,338評(píng)論 0贊 24
  • 一樁弒父案曾棕，背后竟有這般陰謀
    文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至菜循，卻和暖如春翘地，著一層夾襖步出監(jiān)牢的瞬間，已是汗流浹背癌幕。 一陣腳步聲響...
    開封第一講書人閱讀 33,458評(píng)論 1贊 272
  • 情欲美人皮
    我被黑心中介騙來泰國打工衙耕， 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留，地道東北人勺远。 一個(gè)月前我還...
    沈念sama閱讀 48,906評(píng)論 3贊 376
  • 代替公主和親
    正文 我出身青樓橙喘，卻偏偏與公主長得像，于是被迫代替她去往敵國和親胶逢。 傳聞我的和親對(duì)象是個(gè)殘疾皇子厅瞎，可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,507評(píng)論 2贊 359

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