Django Restful Framework
1. 下載安裝
pip install djangorestframework
pip install markdown
pip install django-filter
或者直接從github上下載項目
git clone
git@github.com:encode/django-rest-framework.git
2. 項目支持
打開自己的Django項目,在項目配置文件settings.py中醉旦,添加應(yīng)用配置
INSTALLED_APPS =(
…
‘rest_framework’
)
在項目根路由中默辨,添加restframework認(rèn)證路由
INSTALLED_APPS = [
......
'rest_framework',
]
3. 操作案例
第一個案例惋鹅,創(chuàng)建一個基于數(shù)據(jù)模型操作的api接口
完成對用戶數(shù)據(jù)的讀寫操作
rest framework任何配置都是基于全局的REST_FRAMEWORK配置選項急黎,打開你的Django項目配置文件settings.py闽铐,添加如下配置
REST_FRAMEWORK = {
'DEFAULT_PERMISSION_CLASS': [
'rest_framework.permissions.DjangoModelPermissionOrAnonReadOnly'
]
}
備注:別忘記在你的INSTALLED_APPS中添加rest_framework哦!
接下來占拍,在我們的主路由urls.py中略就,添加數(shù)據(jù)模型的處理方式捎迫,如下:
"""myrest_ex01 URL Configuration
The `urlpatterns` list routes URLs to views. For more information please see:
https://docs.djangoproject.com/en/2.0/topics/http/urls/
Examples:
Function views
1\. Add an import: from my_app import views
2\. Add a URL to urlpatterns: path('', views.home, name='home')
Class-based views
1\. Add an import: from other_app.views import Home
2\. Add a URL to urlpatterns: path('', Home.as_view(), name='home')
Including another URLconf
1\. Import the include() function: from django.urls import include, path
2\. Add a URL to urlpatterns: path('blog/', include('blog.urls'))
"""
from django.contrib import admin
from django.conf.urls import url, include
from django.contrib.auth.models import User
from rest_framework import routers, serializers, viewsets
class UserSerializer(serializers.HyperlinkedModelSerializer):
class Meta:
model = User
fields = ['url', 'username', 'email', 'is_staff']
class UserViewSet(viewsets.ModelViewSet):
queryset = User.objects.all()
serializer_class = UserSerializer
router = routers.DefaultRouter()
router.register(r'users', UserViewSet)
urlpatterns = [
url(r'^', include(router.urls)),
url(r'^api_auth/', include('rest_framework.urls')),
]
4. 運(yùn)行測試
打開瀏覽器,訪問http://localhost:8000表牢,就可以看到restful接口描述了
image
PS:由于手工編寫之后編輯器渲染時可能會出現(xiàn)代碼渲染縮進(jìn)出錯窄绒,所以大家在看代碼的過程中盡量注意!