Drf01 / restful specification, drf acquaintance / django rest framewok
The first part of the question
Before and after the end of the separation?
- vue.js
- The back end to the front section return json data
Moving end prevailed.
- app
- App backend to return json data
PC-side application?
crm项目,前段后端一起写,运行在浏览器上。 一般情况下都是PC端使用。
The second part of the task
Before us:
http://127.0.0.1:8000/info/get/
http://127.0.0.1:8000/info/add/
http://127.0.0.1:8000/info/update/
http://127.0.0.1:8000/info/delete/
Now we have: to follow restful specification
http://127.0.0.1:8000/info/
get,获取数据
post,添加
put,更新
delete,删除
: Django can implement an interface specification based on the development of follow restful
- FBV, can achieve much trouble.
- CBV, as compared to short-answer method according distinction made different.
The third part acquaintance drf
3.1 Installation
pip3 install djangorestframework
3.2
Register app
INSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', 'rest_framework' ]
Write route
from django.conf.urls import url from django.contrib import admin from api import views urlpatterns = [ url(r'^drf/info/', views.DrfInfoView.as_view()), ]
Write view
from rest_framework.views import APIView from rest_framework.response import Response class DrfInfoView(APIView): def get(self,request,*args,**kwargs): data = [ {'id': 1, 'title': '震惊了...王阳居然...', 'content': '...'}, {'id': 2, 'title': '震惊了...王阳居然...', 'content': '...'}, {'id': 3, 'title': '震惊了...王阳居然...', 'content': '...'}, {'id': 4, 'title': '震惊了...王阳居然...', 'content': '...'}, ] return Response(data)
DRF application scenarios
以后在公司参与前后端分离项目、参与为app写接口时,用drf会比较方便。
to sum up
restful specification
1.给别人提供一个URL,根据URL请求方式的不同,做不同操作。 get,获取 post,增加 put,全部更新 patch,局部更新 delete,删除 2.数据传输基于json格式。
drf framework
不基于drf也可以实现restful规范来开发接口程序。 使用了drf之后,可以快速帮我们开发restful规范来开发接口。
fourth part
4.1 to create and initialize a database program
4.2 Interface: When implementing access interface, create an article type
from django.conf.urls import url
from django.contrib import admin
from api import views
urlpatterns = [
url(r'^drf/category/', views.DrfCategoryView.as_view()),
]
from rest_framework.views import APIView
from rest_framework.response import Response
class DrfCategoryView(APIView):
pass
Assumptions: I'm the preceding, you are back end.
After the completion of the development tell the front:
http://127.0.0.1:8000/drf/category/
Requesting analog front-end tool: postman
x-www-urlencoded
request.body: name=alex&age=19&gender=12
request.POST: {'name': ['alex'], 'age': ['19'], 'gender': ['12']}
json
request.body: b'{"ID":1,"name":"Alex","age":19}'
request.POST: 没有值
Answers
from django.conf.urls import url
from django.contrib import admin
from api import views
urlpatterns = [
url(r'^admin/', admin.site.urls),
url(r'^info/', views.InfoView.as_view()),
url(r'^drf/info/', views.DrfInfoView.as_view()),
url(r'^drf/category/', views.DrfCategoryView.as_view()),
]
from api import models
class DrfCategoryView(APIView):
def post(self,request,*args,**kwargs):
"""增加一条分类信息"""
models.Category.objects.create(**request.data)
return Response('成功')
4.3 Interface: Get all post types
from api import models
class DrfCategoryView(APIView):
def get(self,request,*args,**kwargs):
"""获取所有文章分类"""
queryset = models.Category.objects.all().values('id','name')
data_list = list(queryset)
return Response(data_list)
def post(self,request,*args,**kwargs):
"""增加一条分类信息"""
models.Category.objects.create(**request.data)
return Response('成功')
4.4 Interface: Get more information about an article type
from django.conf.urls import url
from django.contrib import admin
from api import views
urlpatterns = [
url(r'^drf/category/$', views.DrfCategoryView.as_view()),
url(r'^drf/category/(?P<pk>\d+)/$', views.DrfCategoryView.as_view()),
]
from api import models
from django.forms.models import model_to_dict
class DrfCategoryView(APIView):
def get(self,request,*args,**kwargs):
"""获取所有文章分类/单个文章分类"""
pk = kwargs.get('pk')
if not pk:
queryset = models.Category.objects.all().values('id','name')
data_list = list(queryset)
return Response(data_list)
else:
category_object = models.Category.objects.filter(id=pk).first()
data = model_to_dict(category_object)
return Response(data)
def post(self,request,*args,**kwargs):
"""增加一条分类信息"""
models.Category.objects.create(**request.data)
return Response('成功')
4.5 Interface: Update and Delete article classification
from django.conf.urls import url
from django.contrib import admin
from api import views
urlpatterns = [
url(r'^drf/category/$', views.DrfCategoryView.as_view()),
url(r'^drf/category/(?P<pk>\d+)/$', views.DrfCategoryView.as_view()),
]
from api import models
from django.forms.models import model_to_dict
class DrfCategoryView(APIView):
def get(self,request,*args,**kwargs):
"""获取所有文章分类/单个文章分类"""
pk = kwargs.get('pk')
if not pk:
queryset = models.Category.objects.all().values('id','name')
data_list = list(queryset)
return Response(data_list)
else:
category_object = models.Category.objects.filter(id=pk).first()
data = model_to_dict(category_object)
return Response(data)
def post(self,request,*args,**kwargs):
"""增加一条分类信息"""
models.Category.objects.create(**request.data)
return Response('成功')
def delete(self,request,*args,**kwargs):
"""删除"""
pk = kwargs.get('pk')
models.Category.objects.filter(id=pk).delete()
return Response('删除成功')
def put(self,request,*args,**kwargs):
"""更新"""
pk = kwargs.get('pk')
models.Category.objects.filter(id=pk).update(**request.data)
return Response('更新成功')
The fifth part of the sequence of drf
drf of serializers help us provide
- Data validation
- Serialization
from django.conf.urls import url
from django.contrib import admin
from api import views
urlpatterns = [
url(r'^admin/', admin.site.urls),
url(r'^info/$', views.InfoView.as_view()),
url(r'^drf/info/$', views.DrfInfoView.as_view()),
url(r'^drf/category/$', views.DrfCategoryView.as_view()),
url(r'^drf/category/(?P<pk>\d+)/$', views.DrfCategoryView.as_view()),
url(r'^new/category/$', views.NewCategoryView.as_view()),
url(r'^new/category/(?P<pk>\d+)/$', views.NewCategoryView.as_view()),
]
from rest_framework import serializers
class NewCategorySerializer(serializers.ModelSerializer):
class Meta:
model = models.Category
# fields = "__all__"
fields = ['id','name']
class NewCategoryView(APIView):
def get(self,request,*args,**kwargs):
pk = kwargs.get('pk')
if not pk:
queryset = models.Category.objects.all()
ser = NewCategorySerializer(instance=queryset,many=True)
return Response(ser.data)
else:
model_object = models.Category.objects.filter(id=pk).first()
ser = NewCategorySerializer(instance=model_object, many=False)
return Response(ser.data)
def post(self,request,*args,**kwargs):
ser = NewCategorySerializer(data=request.data)
if ser.is_valid():
ser.save()
return Response(ser.data)
return Response(ser.errors)
def put(self,request,*args,**kwargs):
pk = kwargs.get('pk')
category_object = models.Category.objects.filter(id=pk).first()
ser = NewCategorySerializer(instance=category_object,data=request.data)
if ser.is_valid():
ser.save()
return Response(ser.data)
return Response(ser.errors)
def delete(self,request,*args,**kwargs):
pk = kwargs.get('pk')
models.Category.objects.filter(id=pk).delete()
return Response('删除成功')
to sum up
What is before and after the end of the separation?
前端所有用到的数据都是后端通过异步接口的方式提供的,前端只管页面的展示及效果。
drf components
帮助我们在django框架基础上快速搭建遵循restful规范接口的程序。
Functional components drf
- Parser, parse request data volume, turning it into a format we want. request.data
- Serialization of an object or a list of objects (QuerySet) serialized form validation operations and functions.
- View, inheritance APIView (inherited django's View inside apiview)
postman
模拟浏览器进行发送请求
Find the order template
优先根目录下:templates 根据app的注册顺序去每个app的templates目录中找。
At the end of the URL add terminator
Homework: do CRUD table for article
from django.conf.urls import url
from django.contrib import admin
from api import views
urlpatterns = [
url(r'^admin/', admin.site.urls),
url(r'^info/$', views.InfoView.as_view()),
url(r'^drf/info/$', views.DrfInfoView.as_view()),
url(r'^drf/category/$', views.DrfCategoryView.as_view()),
url(r'^drf/category/(?P<pk>\d+)/$', views.DrfCategoryView.as_view()),
url(r'^new/category/$', views.NewCategoryView.as_view()),
url(r'^new/category/(?P<pk>\d+)/$', views.NewCategoryView.as_view()),
# get获取列表
# post增加数据
url(r'^drf/article/$', views.ArticleView.as_view()),
url(r'^drf/article/(?P<pk>\d+)/$', views.ArticleView.as_view()),
]
class ArticleView(APIView):
def get(self,request,*args,**kwargs):
pk = kwargs.get('pk')
if not pk:
queryset = models.Article.objects.all()
ser = serializer.ArticleSerializer(instance=queryset,many=True)
return Response(ser.data)
article_object = models.Article.objects.filter(id=pk).first()
ser = serializer.ArticleSerializer(instance=article_object, many=False)
return Response(ser.data)
def post(self,request,*args,**kwargs):
ser = serializer.ArticleSerializer(data=request.data)
if ser.is_valid():
ser.save()
return Response(ser.data)
return Response(ser.errors)
def put(self,request,*args,**kwargs):
"""全部更新"""
pk = kwargs.get('pk')
article_object = models.Article.objects.filter(id=pk).first()
ser = serializer.ArticleSerializer(instance=article_object,data=request.data)
if ser.is_valid():
ser.save()
return Response(ser.data)
return Response(ser.errors)
def patch(self,request,*args,**kwargs):
"""局部"""
pk = kwargs.get('pk')
article_object = models.Article.objects.filter(id=pk).first()
ser = serializer.ArticleSerializer(instance=article_object, data=request.data,partial=True)
if ser.is_valid():
ser.save()
return Response(ser.data)
return Response(ser.errors)
def delete(self,request,*args,**kwargs):
pk = kwargs.get('pk')
models.Article.objects.filter(id=pk).delete()
return Response('删除成功')
from rest_framework import serializers
from api import models
class ArticleSerializer(serializers.ModelSerializer):
category_txt = serializers.CharField(source='category.name',required=False)
x1 = serializers.SerializerMethodField()
status_txt = serializers.CharField(source='get_status_display',required=False)
x2 = serializers.SerializerMethodField()
class Meta:
model = models.Article
# fields = "__all__"
fields = ['id','title','summary','content','category','category_txt','x1','status','status_txt','x2']
# depth = 1
def get_x1(self,obj):
return obj.category.name
def get_x2(self,obj):
return obj.get_status_display()