Django Rest Framework

1、什麼是RESTful

  • REST與技術無關,表明的是一種軟件架構風格,REST是Representational State Transfer的簡稱,中文翻譯爲「表徵狀態轉移」
  • REST從資源的角度類審視整個網絡,它將分佈在網絡中某個節點的資源經過URL進行標識,客戶端應用經過URL來獲取資源的表徵,得到這些表徵導致這些應用轉變狀態
  • 全部的數據,不過是經過網絡獲取的仍是操做(增刪改查)的數據,都是資源,將一切數據視爲資源是REST區別與其餘架構風格的最本質屬性
  • 對於REST這種面向資源的架構風格,有人提出一種全新的結構理念,即:面向資源架構(ROA:Resource Oriented Architecture)

2、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:指定篩選條件
  • 狀態碼
  
 1 OK - [GET]:服務器成功返回用戶請求的數據,該操做是冪等的(Idempotent)。
 2 CREATED - [POST/PUT/PATCH]:用戶新建或修改數據成功。
 3 Accepted - [*]:表示一個請求已經進入後臺排隊(異步任務)
 4 NO CONTENT - [DELETE]:用戶刪除數據成功。
 5 INVALID REQUEST - [POST/PUT/PATCH]:用戶發出的請求有錯誤,服務器沒有進行新建或修改數據的操做,該操做是冪等的。
 6 Unauthorized - [*]:表示用戶沒有權限(令牌、用戶名、密碼錯誤)。
 7 Forbidden - [*] 表示用戶獲得受權(與401錯誤相對),可是訪問是被禁止的。
 8 NOT FOUND - [*]:用戶發出的請求針對的是不存在的記錄,服務器沒有進行操做,該操做是冪等的。
 9 Not Acceptable - [GET]:用戶請求的格式不可得(好比用戶請求JSON格式,可是隻有XML格式)。
10 Gone -[GET]:用戶請求的資源被永久刪除,且不會再獲得的。
11 Unprocesable entity - [POST/PUT/PATCH] 當建立一個對象時,發生一個驗證錯誤。
12 INTERNAL SERVER ERROR - [*]:服務器發生錯誤,用戶將沒法判斷髮出的請求是否成功。
13 
14 更多看這裏:http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.ht
  • 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格式,可是隻有XML格式)。
  • 410 Gone -[GET]:用戶請求的資源被永久刪除,且不會再獲得的。
  • 422 Unprocesable entity - [POST/PUT/PATCH] 當建立一個對象時,發生一個驗證錯誤。
  • 500 INTERNAL SERVER ERROR - [*]:服務器發生錯誤,用戶將沒法判斷髮出的請求是否成功。
  • 錯誤處理,狀態碼是4xx時,應返回錯誤信息,error當作key
1 {
2     error: "Invalid API key"
3 }

 

  • 返回結果,針對不一樣操做,服務器向用戶返回的結果應該符合如下規範。
1 GET /collection:返回資源對象的列表(數組)
2 GET /collection/resource:返回單個資源對象
3 POST /collection:返回新生成的資源對象
4 PUT /collection/resource:返回完整的資源對象
5 PATCH /collection/resource:返回完整的資源對象
6 DELETE /collection/resource:返回一個空文檔
  • Hypermedia API,RESTful API最好作到Hypermedia,即返回結果中提供連接,連向其餘API方法,使得用戶不查文檔,也知道下一步應該作什麼。
1 {"link": {
2   "rel":   "collection https://www.example.com/zoos",
3   "href":  "https://api.example.com/zoos",
4   "title": "List of zoos",
5   "type":  "application/vnd.yourformat+json"
6 }}

3、基於Django的實現

路由系統:html

1 urlpatterns = [
2     url(r'^users', Users.as_view()),
3 ]

CBV試圖:web

 1 from django.views import View
 2 from django.http import JsonResponse
 3  
 4 class Users(View):
 5     def get(self, request, *args, **kwargs):
 6         result = {
 7             'status': True,
 8             'data': 'response data'
 9         }
10         return JsonResponse(result, status=200)
11  
12     def post(self, request, *args, **kwargs):
13         result = {
14             'status': True,
15             'data': 'response data'
16         }
17         return JsonResponse(result, status=200) 

4、基於Django Rest Framework框架實現

url.pydjango

1 from django.conf.urls import url, include
2 from web.views.s1_api import TestView
3  
4 urlpatterns = [
5     url(r'^test/', TestView.as_view()),
6 ]

views.pyjson

 1 from rest_framework.views import APIView
 2 from rest_framework.response import Response
 3  
 4  
 5 class TestView(APIView):
 6     def dispatch(self, request, *args, **kwargs):
 7         """
 8         請求到來以後,都要執行dispatch方法,dispatch方法根據請求方式不一樣觸發 get/post/put等方法
 9          
10         注意:APIView中的dispatch方法有好多好多的功能
11         """
12         return super().dispatch(request, *args, **kwargs)
13  
14     def get(self, request, *args, **kwargs):
15         return Response('GET請求,響應內容')
16  
17     def post(self, request, *args, **kwargs):
18         return Response('POST請求,響應內容')
19  
20     def put(self, request, *args, **kwargs):
21         return Response('PUT請求,響應內容')

上述是rest framework框架基本流程,重要的功能是在APIView的dispatch中觸發。api

參考文檔:http://www.cnblogs.com/wupeiqi/articles/7805382.html跨域

相關文章
相關標籤/搜索