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

 

 
 
 
 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM