Retsfulはとても優美なhttpインターフェースの設計スタイルと設計規範です。

2594 ワード

--    --
    Restful        http           。  restful       ,                   ,             ,    ,         。
            ,           Restful,           - -
             ,  restful     ,        Restful    。               90%   ,      ,  。

--    --
==   /     ==

  
GET:   url  , :?a=1&b=2
POST:   Json  , request.body    Json, :'{"a": 1, "b": 2}'

  
      json,      (ok_json)     (fail_json)

ok_json  :
{"ok": True, data: {"user_id": 1}, "echo": "", "error": "", "reason": ""}

fail_json  :
{"ok": False, data: {}, "echo": "COMM_INVALID_ARGS", "error": "1001", "reason": "      "}


==      ==
           “User”
  :
1、      “   ”           ,  ok_json  data 
2、       : ( :user_id),        ;      * ( *user_id),       
3、        ,    id    ,        。              display_order,      order    


【  】/user/add/
【    】POST
【  】      User          ,     ,      id  
【  】  user        ,          
【   】:{"id": 3}


【  】/user/update/
【    】POST
【  】     id         
【  】*user_id,*         (       )
【   】{}


【  】/user/view/
【    】GET
【  】    id,     json   
【  】*user_id
【   】{"id": "1", "username": "swpu-lee", "real_name": "lee", "gender": 0, ...}


【  】/user/delete/
【    】GET
【  】      。        ,           is_deleted True。          ,    is_deleted         (                   “is_deleted False”    )
【  】*user_id
【   】{}


【  】/user/query/
【    】GET
【  】             ,             id  。          ,            。
【  】          , :{"age": "11-20", "eye_color": "red", ...}
【   】[1, 2, 3, 5, 78, 121, ...]


【    】/user/view/bulk/
【    】GET
【  】     ids      。       Query        
【  】*user_ids(   :"1,2,3,4,5",     )
【   】{"1": {  1   }, "2": {  2   }, "3": {  3   }, ...}


###          user    ,             ,     “    ”   
【  】/photo/album/list/
【    】GET
【  】      ,       user_id ,            ,             。             ,              
【  】:user_id   None,:offset  0,:limit  20,     json        
【   】{"total_count": 101, "list": [{  1}, {  2}, {  3}, ...]}


【  】/phtot/album/all/
【    】GET
【  】           
【  】*user_id
【   】[{  1}, {  2}, {  3}, ...]



--     --
                      ,        ,           。
                       ,             ,                   。
                       (        ,               ?)。     ,      ,                ,                。