Django rest_framework實作RESTful API

一、什麼是REST

　　面向資源是REST最明顯的特征，資源是一種看待伺服器的方式，将伺服器看作是由很多離散的資源組成。每個資源是伺服器上一個可命名的抽象概念。因為資源是一個抽象的概念，是以它不僅僅能代表伺服器檔案系統中的一個檔案、資料庫中的一張表等等具體的東西，可以将資源設計的要多抽象有多抽象，隻要想象力允許而且用戶端應用開發者能夠了解。

　　與面向對象設計類似，資源是以名詞為核心來組織的，首先關注的是名詞。一個資源可以由一個或多個URI來辨別。URI既是資源的名稱，也是資源在Web上的位址。對某個資源感興趣的用戶端應用，可以通過資源的URI與其進行互動。對于同一個資源的一組不同的操作。資源是伺服器上一個可命名的抽象概念，資源是以名詞為核心來組織的，首先關注的是名詞。

　　REST要求，必須通過統一的接口來對資源執行各種操作。對于每個資源隻能執行一組有限的操作。（7個HTTP方法：GET/POST/PUT/DELETE/PATCH/HEAD/OPTIONS）

二、什麼是RESTful API

符合REST架構設計的API。

這篇文章描述的很好，參考下加深了解 http://www.infoq.com/cn/articles/understanding-restful-style/

概念不多說了，具體通過下面的一個簡單例子看看Django架構是怎麼實作RESTful。

三、rest_framework子產品

1.使用pip指令下載下傳：pip3 install djangorestframework

2.建立一個Django項目

 3.建立一個apitest APP

cd d:\Tool                     # 切換到Tool目錄      

python manage.py startapp apitest   #建立apitest應用      

 目錄結構：

4.打開settings.py，增加一段配置：

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'apitest',                           #添加apitest app
    'rest_framework',                    #添加rest_framework
]


#增加一段REST_FRAMEWORK配置
REST_FRAMEWORK = {
    # Use Django's standard `django.contrib.auth` permissions,
    # or allow read-only access for unauthenticated users.
    'DEFAULT_PERMISSION_CLASSES': [
        'rest_framework.permissions.DjangoModelPermissionsOrAnonReadOnly'
    ],
    'DEFAULT_RENDERER_CLASSES': (
        'rest_framework.renderers.JSONRenderer',
    ),
    'DEFAULT_PARSER_CLASSES': (
        'rest_framework.parsers.JSONParser',
    )
}      

5.在apitest目錄下建立一個api.py，讓我們來寫一些測試代碼：

#coding=utf-8
from rest_framework import permissions
from rest_framework.response import Response
from rest_framework.decorators import api_view, permission_classes
from django.views.decorators.csrf import csrf_exempt



@csrf_exempt
@api_view(http_method_names=['post'])                #隻允許post
@permission_classes((permissions.AllowAny,))
def inventory(request):
    parameter = request.data
    id = parameter['data']
    if id == 1:
        data = 'There are three dogs'
    elif id == 2:
        data = 'There are two dogs'
    else:
        data = 'nothing'

    return Response({'data':data})      

 6.在urls.py添加剛剛建立的api路由：

urlpatterns = [
    path('admin/', admin.site.urls),
    path('food/', api.inventory),               #添加api中inventory路由
]      

上面配置好了之後本地調試下，輸入指令：python manage.py runserver 8000

好了，伺服器端代碼已經寫完。我們可以通過約定好的名詞food來擷取或者更改資源。

然後寫個小腳本測試下上面的接口：

import requests

url= 'http://127.0.0.1:8000/food/'
data = {'data':2}
h=requests.post(url,json=data)
print(h.text)      

輸出：

測試OK