django rest framework個(gè)人學(xué)習(xí)筆記（一）————Install

yuxue 發(fā)布于2019-07-31 12:15 / 1029人閱讀

摘要：本文主要是用來(lái)記錄自己學(xué)習(xí)的過(guò)程。其中可能會(huì)有很多自己的錯(cuò)誤理解。這里主要會(huì)用到的知識(shí)有百度百科阮一峰理解架構(gòu)其余請(qǐng)自行百度。所有的全局設(shè)置都放在的字典中。使用標(biāo)準(zhǔn)的權(quán)限，未認(rèn)證的用戶(hù)只讀權(quán)限不要忘記將添加到你的中。

本文主要是用來(lái)記錄自己學(xué)習(xí)django-rest-framework的過(guò)程。其中可能會(huì)有很多自己的錯(cuò)誤理解。

這里主要會(huì)用到的知識(shí)有

1. [django](https://www.djangoproject.com/)  
2. [django-rest-framework](http://www.django-rest-framework.org/)  
3. restful
    - [百度百科](https://baike.baidu.com/item/RESTful/4406165?fr=aladdin)
    - [阮一峰理解RESTful架構(gòu)](http://www.ruanyifeng.com/blog/2011/09/restful)  
    - 其余請(qǐng)自行百度。  
4. [python](https://www.python.org/)

本系列中使用的版本號(hào)

1. python3.6
2. django1.11.4
3. django-rest-framework3

官方文檔

安裝

pip install djangorestframework
pipinstall django-filter #過(guò)濾支持，官方推薦使用

添加 "rest_framework"到 django settings文件的 INSTALLED_APPS中：

INSTALL_APPS = {
    ...
    "rest_framework",
}

如果你想使用可視化的API,可以添加如下代碼到根urls.py文件中：

urlpatterns = [
    ...
    url(r"^api-auth/",include("rest_framework.urls",namespace="rest_framework")),
]

注意這個(gè)url可以是任何你想要的，但是必須導(dǎo)入 rest_framework.urls，并且 namespace必須為rest_framework。在django1.9+中，你可以不用設(shè)置namespace,rest_framework將會(huì)為你設(shè)置。

例子

讓我們來(lái)看一個(gè)使用 REST framework構(gòu)建的簡(jiǎn)單的 model-backed API.
我們創(chuàng)建一個(gè) read-write API，來(lái)訪問(wèn)我們項(xiàng)目中用戶(hù)的信息。
REST framework API 所有的全局設(shè)置都放在 settings.py的 REST_FRAMEWORK字典中。

REST_FRAMEWORK = {
    # 使用django標(biāo)準(zhǔn)的 "django.contrib.auth"權(quán)限，未認(rèn)證的用戶(hù)只讀權(quán)限
    "DEFAULT_PERMISSION_CLASSES": [
        "rest_framework.premissions.DjangoModelPermissionOrAnonReadOnly"
    ]
}

不要忘記將 rest_framework添加到你的INSTALLED_APPS中。
我們現(xiàn)在準(zhǔn)備創(chuàng)建我們的API了。在我們的根urls.py模塊中：

from django.conf.urls import url, include
from django.contrib.auth.models import User
from rest_framework import routers, serializers, viewsets

# Seriallzers 定義這個(gè)API的表現(xiàn)
class UserSerializer(serializers.HyperlinkModelSerializer):
    class Meta:
        model = User
        fields = ("url","username","email","is_staff")
  

#ViewSets定義這個(gè)API的行為
class UserViewSet(viewsets.ModelViewSet):
    queryset = User.objects.all()
    serializer_class = UserSerializer
   
#Routers提供了一種簡(jiǎn)單的方式來(lái)設(shè)置url
router = routers.DefaultRouter()
router.register(r"users",UserViewSet)

#使用URL路由自動(dòng)連接我們的API
#此外，我們還添加了一個(gè)可視化的Url
urlpatterns = [
    url("^",include(router.urls)),
    url("^api-auth/",include("rest_framework.urls"),namesapce="rest_framework"),
]