rest_framework規範

面向資源架構：

　　十條規範：（並非強制性的，能夠根據項目作出調整）

　　   1.使用HTTPS協議進行數據之間的傳輸，保證數據更安全   

　　   2.域名的區分

　　  https://api.example.com https://example.org/api/ 

 

　　  3.版本能夠放在路徑中　　

　　 https://api.example.com/v1/zoos 這裏的v1便是表示接口版本

　　  4.經過method區分操做

　　  get   # 獲取資源
　　  post   # 新增資源
　　  put（客戶端提供改變後的完整資源）/patch（客戶端提供改變的屬性）   # 更新資源
　　　delete   # 刪除資源

  　　5.路徑    視網絡上任何東西都是資源，均使用名詞表示（可複數）

　　  https://api.example.com/v1/zoos
　　  https://api.example.com/v1/animals
　　  https://api.example.com/v1/employees

　　  6.過濾    經過在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：指定篩選條件

 　　 7.狀態碼   https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html

　　  8.錯誤處理，應返回錯誤信息，error當作key。

　　{
  　　  error: "Invalid API key"
　　}

　　  9.返回結果，針對不一樣操做，服務器向用戶返回的結果應該符合如下規範。

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

　　  10.Hypermedia API，RESTful API最好作到Hypermedia，即返回結果中提供連接，連向其餘API方法，使得用戶不查文檔，也知道下一步應該作什麼。

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

 

 

基於Django實現

# 路由編寫

urlpatterns = [
    url(r'^users/$', views.Users.as_view()),
    url(r'^users2/$', views.user2),

]

# 視圖編寫

 

import json

def  user2(request):
    if request.method=='GET':
        dic = {'status':200,'name': 'lqz2', 'age': 18}
        return HttpResponse(json.dumps(dic))
    elif request.method=='POST':
        dic = {'status': 200, 'msg': '修改爲功'}
        return JsonResponse(dic)

class Users(View):
    def get(self, request):
        dic = {'status':200,'name': 'lqz', 'age': 18}
        return HttpResponse(json.dumps(dic))

    def post(self, request):
        dic = {'status': 200, 'msg': '修改爲功'}
        return JsonResponse(dic)