1. 程式人生 > >$Django RESTful規範

$Django RESTful規範

一 什麼是RESTful

  • REST與技術無關,代表的是一種軟體架構風格,REST是Representational State Transfer的簡稱,中文翻譯為“表徵狀態轉移”
  • REST從資源的角度類審視整個網路,它將分佈在網路中某個節點的資源通過URL進行標識,客戶端應用通過URL來獲取資源的表徵,獲得這些表徵致使這些應用轉變狀態
  • REST與技術無關,代表的是一種軟體架構風格,REST是Representational State Transfer的簡稱,中文翻譯為“表徵狀態轉移”
  • 所有的資料,不過是通過網路獲取的還是操作(增刪改查)的資料,都是資源,將一切資料視為資源是REST區別與其他架構風格的最本質屬性
  • 對於REST這種面向資源的架構風格,有人提出一種全新的結構理念,即:面向資源架構(ROA:Resource Oriented Architecture)
是一個規範,面向資源程式設計:把網路中所有東西,想象成資源
View Code

二  RESTful API規範設計(10條)

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:指定篩選條件

狀態碼

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 - [*]:伺服器發生錯誤,使用者將無法判斷髮出的請求是否成功。

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

錯誤處理,應返回錯誤資訊,error當做key。

{
    error: "Invalid API key"
}

返回結果,針對不同操作,伺服器向用戶返回的結果應該符合以下規範。

GET /collection:返回資源物件的列表(陣列)
GET /collection/resource:返回單個資源物件
POST /collection:返回新生成的資源物件
PUT /collection/resource:返回完整的資源物件
PATCH /collection/resource:返回完整的資源物件
DELETE /collection/resource:返回一個空文件

Hypermedia API,RESTful API最好做到Hypermedia,即返回結果中提供連結,連向其他API方法,使得使用者不查文件,也知道下一步應該做什麼。

    {
                    status:100
                    msg:成功
                    url:127.0.0.1/books/1
                }
            核心:返回結果中提供連結

三 postman軟體:模擬發請求的軟體

四 django寫resful規範的介面

路由

urlpatterns = [
    url(r'^books/$', views.show.as_view()),
    url(r'^books/(?P<pk>\d+)', views.show.as_view()),
]

檢視函式

class show (View):                #增刪改查
    def get(self,request):
        print (request.POST)
        print (request.GET)
        print (request.body)
        return JsonResponse ({})
    def post(self,request): #post有querydict,body有資料比如b'name=1'
        print (request.POST)
        print (request.GET)
        print (request.body)
        return JsonResponse ({})
    def put(self,request,pk):  #只有body有
        import json
        dic=json.loads(request.body.decode('utf-8'))
        name = dic.get ('name')
        models.Books.objects.filter(pk=pk).update(name=name)
        return JsonResponse({'status':100,'msg':'修改成功'})
    def delete(self,request,pk):#只有body有
        print(request.POST)
        print(request.GET)
        print(request.body)
        return JsonResponse({})
    def patch(self,request,pk):#只有body有
        print (request.POST)
        print (request.GET)
        print (request.body)
        return JsonResponse ({})