Django rest_framework實(shí)現(xiàn)RESTful API-曬酷學(xué)院

一、什么是REST

面向資源是REST最明顯的特征,資源是一種看待服務(wù)器的方式,將服務(wù)器看作是由很多離散的資源組成。每個(gè)資源是服務(wù)器上一個(gè)可命名的抽象概念。因?yàn)橘Y源是一個(gè)抽象的概念,所以它不僅僅能代表服務(wù)器文件系統(tǒng)中的一個(gè)文件、數(shù)據(jù)庫中的一張表等等具體的東西,可以將資源設(shè)計(jì)的要多抽象有多抽象,只要想象力允許而且客戶端應(yīng)用開發(fā)者能夠理解。

與面向?qū)ο笤O(shè)計(jì)類似,資源是以名詞為核心來組織的,首先關(guān)注的是名詞。一個(gè)資源可以由一個(gè)或多個(gè)URI來標(biāo)識(shí)。URI既是資源的名稱,也是資源在Web上的地址。對(duì)某個(gè)資源感興趣的客戶端應(yīng)用,可以通過資源的URI與其進(jìn)行交互。對(duì)于同一個(gè)資源的一組不同的操作。資源是服務(wù)器上一個(gè)可命名的抽象概念,資源是以名詞為核心來組織的,首先關(guān)注的是名詞。

REST要求,必須通過統(tǒng)一的接口來對(duì)資源執(zhí)行各種操作。對(duì)于每個(gè)資源只能執(zhí)行一組有限的操作。(7個(gè)HTTP方法:GET/POST/PUT/DELETE/PATCH/HEAD/OPTIONS)

二、什么是RESTful API

符合REST架構(gòu)設(shè)計(jì)的API。

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

三、rest_framework模塊

1.使用pip命令下載:pip3 install djangorestframework


image.png

2.新建一個(gè)Django項(xiàng)目


image.png

image.png

3.創(chuàng)建一個(gè)apitest APP
cd d:\Tool                     # 切換到Tool目錄
python manage.py startapp apitest   #創(chuàng)建apitest應(yīng)用

目錄結(jié)構(gòu):


image.png

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目錄下新建一個(gè)api.py,讓我們來寫一些測(cè)試代碼:

#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添加剛剛創(chuàng)建的api路由:

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

上面配置好了之后本地調(diào)試下,輸入命令:python manage.py runserver 8000


image.png

好了,服務(wù)器端代碼已經(jīng)寫完。我們可以通過約定好的名詞food來獲取或者更改資源。
然后寫個(gè)小腳本測(cè)試下上面的接口:

import requests

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

輸出:


image.png

測(cè)試OK

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容