RESTful瑙勮寖

Posted 2021-01-26

鏍囩锛?a href='http://www.mamicode.com/so/1/%e7%bb%93%e6%9e%9c' title='缁撴灉'>缁撴灉   author   鏀瑰彉   澶氭   澶勭悊   offset   鐘舵€佺爜   toc   璁板綍   

•API涓庣敤鎴风殑閫氫俊鍗忚锛屾€绘槸浣跨敤HTTPs鍗忚:https姣攈ttp瀹夊叏

•鍩熷悕 
?https://api.example.com                         灏介噺灏咥PI閮ㄧ讲鍦ㄤ笓鐢ㄥ煙鍚嶏紙浼氬瓨鍦ㄨ法鍩熼棶棰橈級
?https://example.org/api/                        API寰堢畝鍗?

•鐗堟湰 
?URL锛屽锛歨ttps://api.example.com/v1/
?璇锋眰澶?                                                 璺ㄥ煙鏃讹紝寮曞彂鍙戦€佸娆¤姹?

•璺緞锛岃缃戠粶涓婁换浣曚笢瑗块兘鏄祫婧愶紝鍧囦娇鐢ㄥ悕璇嶈〃绀猴紙鍙鏁帮級 
?https://api.example.com/v1/zoos
?https://api.example.com/v1/animals
?https://api.example.com/v1/employees

•method 
?GET      锛氫粠鏈嶅姟鍣ㄥ彇鍑鸿祫婧愶紙涓€椤规垨澶氶」锛?
?POST    锛氬湪鏈嶅姟鍣ㄦ柊寤轰竴涓祫婧?
?PUT      锛氬湪鏈嶅姟鍣ㄦ洿鏂拌祫婧愶紙瀹㈡埛绔彁渚涙敼鍙樺悗鐨勫畬鏁磋祫婧愶級
?PATCH  锛氬湪鏈嶅姟鍣ㄦ洿鏂拌祫婧愶紙瀹㈡埛绔彁渚涙敼鍙樼殑灞炴€э級
?DELETE 锛氫粠鏈嶅姟鍣ㄥ垹闄よ祫婧?

•杩囨护锛岄€氳繃鍦╱rl涓婁紶鍙傜殑褰㈠紡浼犻€掓悳绱㈡潯浠?
?https://api.example.com/v1/zoos?limit=10锛氭寚瀹氳繑鍥炶褰曠殑鏁伴噺
?https://api.example.com/v1/zoos?offset=10锛氭寚瀹氳繑鍥炶褰曠殑寮€濮嬩綅缃?
?https://api.example.com/v1/zoos?page=2&per_page=100锛氭寚瀹氱鍑犻〉锛屼互鍙婃瘡椤电殑璁板綍鏁?
?https://api.example.com/v1/zoos?sortby=name&order=asc锛氭寚瀹氳繑鍥炵粨鏋滄寜鐓у摢涓睘鎬ф帓搴忥紝浠ュ強鎺掑簭椤哄簭
?https://api.example.com/v1/zoos?animal_type_id=1锛氭寚瀹氱瓫閫夋潯浠?

•鐘舵€佺爜


200 OK - [GET]锛氭湇鍔″櫒鎴愬姛杩斿洖鐢ㄦ埛璇锋眰鐨勬暟鎹紝璇ユ搷浣滄槸骞傜瓑鐨勶紙Idempotent锛夈€?
201 CREATED - [POST/PUT/PATCH]锛氱敤鎴锋柊寤烘垨淇敼鏁版嵁鎴愬姛銆?
202 Accepted - [*]锛氳〃绀轰竴涓姹傚凡缁忚繘鍏ュ悗鍙版帓闃燂紙寮傛浠诲姟锛?
204 NO CONTENT - [DELETE]锛氱敤鎴峰垹闄ゆ暟鎹垚鍔熴€?
400 INVALID REQUEST - [POST/PUT/PATCH]锛氱敤鎴峰彂鍑虹殑璇锋眰鏈夐敊璇紝鏈嶅姟鍣ㄦ病鏈夎繘琛屾柊寤烘垨淇敼鏁版嵁鐨勬搷浣滐紝璇ユ搷浣滄槸骞傜瓑鐨勩€?
401 Unauthorized - [*]锛氳〃绀虹敤鎴锋病鏈夋潈闄愶紙浠ょ墝銆佺敤鎴峰悕銆佸瘑鐮侀敊璇級銆?
403 Forbidden - [*] 琛ㄧず鐢ㄦ埛寰楀埌鎺堟潈锛堜笌401閿欒鐩稿锛夛紝浣嗘槸璁块棶鏄绂佹鐨勩€?
404 NOT FOUND - [*]锛氱敤鎴峰彂鍑虹殑璇锋眰閽堝鐨勬槸涓嶅瓨鍦ㄧ殑璁板綍锛屾湇鍔″櫒娌℃湁杩涜鎿嶄綔锛岃鎿嶄綔鏄箓绛夌殑銆?
406 Not Acceptable - [GET]锛氱敤鎴疯姹傜殑鏍煎紡涓嶅彲寰楋紙姣斿鐢ㄦ埛璇锋眰JSON鏍煎紡锛屼絾鏄彧鏈塜ML鏍煎紡锛夈€?
410 Gone -[GET]锛氱敤鎴疯姹傜殑璧勬簮琚案涔呭垹闄わ紝涓斾笉浼氬啀寰楀埌鐨勩€?
422 Unprocesable entity - [POST/PUT/PATCH] 褰撳垱寤轰竴涓璞℃椂锛屽彂鐢熶竴涓獙璇侀敊璇€?
500 INTERNAL SERVER ERROR - [*]锛氭湇鍔″櫒鍙戠敓閿欒锛岀敤鎴峰皢鏃犳硶鍒ゆ柇鍙戝嚭鐨勮姹傛槸鍚︽垚鍔熴€?

鏇村鐪嬭繖閲岋細http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html


•閿欒澶勭悊锛屽簲杩斿洖閿欒淇℃伅锛宔rror褰撳仛key銆?br />

{

    error: "Invalid API key"

}

• 杩斿洖缁撴灉锛岄拡瀵逛笉鍚屾搷浣滐紝鏈嶅姟鍣ㄥ悜鐢ㄦ埛杩斿洖鐨勭粨鏋滃簲璇ョ鍚堜互涓嬭鑼冦€?/li>

 

GET /collection锛氳繑鍥炶祫婧愬璞＄殑鍒楄〃锛堟暟缁勶級

GET /collection/resource锛氳繑鍥炲崟涓祫婧愬璞?/code>

POST /collection锛氳繑鍥炴柊鐢熸垚鐨勮祫婧愬璞?/code>

PUT /collection/resource锛氳繑鍥炲畬鏁寸殑璧勬簮瀵硅薄

PATCH /collection/resource锛氳繑鍥炲畬鏁寸殑璧勬簮瀵硅薄

DELETE /collection/resource锛氳繑鍥炰竴涓┖鏂囨。

• Hypermedia API锛孯ESTful API鏈€濂藉仛鍒癏ypermedia锛屽嵆杩斿洖缁撴灉涓彁渚涢摼鎺ワ紝杩炲悜鍏朵粬API鏂规硶锛屼娇寰楃敤鎴蜂笉鏌ユ枃妗ｏ紝涔熺煡閬撲笅涓€姝ュ簲璇ュ仛浠€涔堛€?/li>

{
      status:100
      msg:鎴愬姛
      url:127.0.0.1/books/1
   }
鏍稿績:杩斿洖缁撴灉涓彁渚涢摼鎺?/pre>