restful api 、狀態碼

http://www.cnblogs.com/wupeiqi/articles/7805382.html   銀角博客Django Rest Framework  里面有各種東西

 ———————————————————————

http://www.cnblogs.com/wupeiqi/articles/7805382.html   十條規范，看銀角博客

RESTful API設計

• API與用戶的通信協議，總是使用HTTPs協議。
• 域名 
  • https://api.example.com                         盡量將API部署在專用域名（會存在跨域問題）
  • https://example.org/api/                        API很簡單
• 版本
  • URL，如：https://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 ：從服務器刪除資源
• 過濾，通過在url上傳參的形式傳遞搜索條件
  • 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：指定篩選條件
• 狀態碼
• 錯誤處理，狀態碼是4xx時，應返回錯誤信息，error當做key。
  

  1 2 3

  {      error:  "Invalid API key" }

• 返回結果，針對不同操作，服務器向用戶返回的結果應該符合以下規范。

• 1 2 3 4 5 6

  GET  / collection：返回資源對象的列表（數組） GET  / collection / resource：返回單個資源對象 POST  / collection：返回新生成的資源對象 PUT  / collection / resource：返回完整的資源對象 PATCH  / collection / resource：返回完整的資源對象 DELETE  / collection / resource：返回一個空文檔

• Hypermedia API，RESTful API最好做到Hypermedia，即返回結果中提供鏈接，連向其他API方法，使得用戶不查文檔，也知道下一步應該做什么。
  

  1 2 3 4 5 6

  { "link" : {    "rel" :    "collection https://www.example.com/zoos" ,    "href" :   "https://api.example.com/zoos" ,    "title" :  "List of zoos" ,    "type" :   "application/vnd.yourformat+json" }}

 

 

rest API 10條規范；    流程------》》按照下面的流程記住，這樣方便記憶。

https》》》域名》》版本》》名詞》》url后可加條件，條件里面可加分頁》》》》methods做請求》》return狀態碼，有錯誤信息發錯誤信息》》

返回值》》》headlink（這個是啥，不太確定）

———————————————————————

rest是一個規范，具體情況要具體分析，並不是死的。

restful api：（或者看上面的網址，里面是銀角的博客）

　　一種軟件架構風格、設計風格，而不是標准，只是提供了一組設計原則和約束條件。它主要用於客戶端和服務器交互類的軟件。基於這個風格設計的軟件可以更簡潔，更有層次，更易於實現緩存等機制。

談談你對restful api的認識？

把這個流程整理下

路由》》》視圖》》as_view--- >返回view-->dispatch--->先有版本處理-->權限--->節流，走完之后通過反射取數據；》》》》》由解析器進行轉換數據》》》》》》》序列化進行數據校驗是否合法（ serialize來操作）》》》》數據正確需要用分頁進行》》分頁之后把數據返回給頁面，頁面進行渲染

原來web應用程序時，根據URL不同定位到不同視圖函數處理。
        rest是一種規范：面向資源
http://api.luffycity.com/v1/users
            - 協議：
                http
                https
            - 域名
api.luffycity.com
www.luffycity.com/api
            - 版本
                
            - url中是名詞
            - method不同執行不同函數：get/post/delete/put/patch
            - 返回狀態碼：200/301/302/404/403/500
            - 錯誤信息：
                {
                   msg: '用戶名或密碼錯誤'
                }
                def index(request):
                    ret = {'code':1000,'data':None}

                    return HttpResponse('xxx',status=200)
            - 返回值：
http://api.luffycity.com/v1/users
http://api.luffycity.com/v1/users/1
                
            - 條件
http://api.luffycity.com/v1/users?page=1&size=10
                
                PS: 主鍵ID體現在URL上
            - hyperlink
                {
                    id: '老司機',
                    age: 18,
                    group: http://www.luffycti.com/api/v1/group/1/
                }

 

很多內容請看銀角博客，這里只放個狀態碼：》》

ps：自己博客整理狀態碼http://www.cnblogs.com/heysn21/articles/8808555.html

OK - [GET]：服務器成功返回用戶請求的數據，該操作是冪等的（Idempotent）。
CREATED - [POST/PUT/PATCH]：用戶新建或修改數據成功。
Accepted - [*]：表示一個請求已經進入后台排隊（異步任務）
NO CONTENT - [DELETE]：用戶刪除數據成功。
INVALID REQUEST - [POST/PUT/PATCH]：用戶發出的請求有錯誤，服務器沒有進行新建或修改數據的操作，該操作是冪等的。
Unauthorized - [*]：表示用戶沒有權限（令牌、用戶名、密碼錯誤）。
Forbidden - [*] 表示用戶得到授權（與401錯誤相對），但是訪問是被禁止的。
NOT FOUND - [*]：用戶發出的請求針對的是不存在的記錄，服務器沒有進行操作，該操作是冪等的。
Not Acceptable - [GET]：用戶請求的格式不可得（比如用戶請求JSON格式，但是只有XML格式）。
Gone -[GET]：用戶請求的資源被永久刪除，且不會再得到的。
Unprocesable entity - [POST/PUT/PATCH] 當創建一個對象時，發生一個驗證錯誤。
INTERNAL SERVER ERROR - [*]：服務器發生錯誤，用戶將無法判斷發出的請求是否成功。

更多看這里：http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html

常用狀態碼列表

后者參考下面的狀態碼網址》》》

https://www.cnblogs.com/aure/p/6433014.html   狀態碼網址