- Restful API介绍
- Django Restful Framework介绍
- 实例学习
##Rest
Rest(Representational State Transfer)表现层状态转化
是一种架构风格：
- 从资源角度来观察整个网络
- 每个URL代表一种资源
- 客户端通过四个http动词对后端进行操作
- get 获取资源
- post 新建一个资源
- put 更新资源
- delete 删除资源
- get /poems
- post /poems
- get poems/id
- put poems/id
- delete poems/id
服务器向客户端返回的状态码和信息提示： 200 OK - [GET]：服务器成功返回用户请求的数据 201 CREATED - [POST/PUT]：用户新建或修改数据成功。 400 INVALID REQUEST - [POST/PUT]：用户发出的请求有错误 更多可以参考：10 Status Code Definitions
一套构建restful API有效和便利的框架 安装：pip install djangorestframework
定义一个serializers.ModelSerializer的子类并设置元数据 【serializers.py】
from rest_framework import serializers
from .models import Poem
class PoemSerializer(serializers.ModelSerializer):
class Meta:
# 制定元数据的model和fields
model = Poem
fields = ['author', 'title', 'type']定义视图函数的操作【views.py】
from rest_framework import status
from rest_framework.response import Response
from .serializers import PoemSerializer
from .models import Poem
class PoemListView(APIView):
def get(self, request, format=None):
poems = Poem.objects.all()
serializer = PoemSerializer(poems, many=True)
return Response(serializer.data)
def post(self, request, format=None):
serializer = PoemSerializer(data=request.data, many=True)
if serializer.is_valid():
serializer.save()
return Response(serializer.data, status=status.HTTP_201_CREATED)
else:
return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)定义路由策略【urls.py】
from django.conf.urls import url
from . import views
urlpatterns = [
url(r'^poems/$', views.PoemListView.as_view(), name="poem_list"),
]定义视图函数的操作【views.py】
@api_view(['GET', 'PUT', 'DELETE'])
def poem_detail(request, pk):
try:
poem = Poem.objects.get(pk=pk)
except Poem.DoesNotExist:
return Response(status=status.HTTP_404_NOT_FOUND)
if request.method == 'GET':
serializer = PoemSerializer(poem)
return Response(serializer.data)
elif request.method == 'PUT':
serializer = PoemSerializer(Poem, request.data)
if serializer.is_valid():
serializer.save()
return Response(serializer.data)
else:
return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
elif request.method == 'DELETE':
poem.delete()
return Response(status=status.HTTP_204_NO_CONTENT)
定义路由策略【urls.py】
from django.conf.urls import url
from . import views
urlpatterns = [
url(r'^poem/(?P<pk>[0-9]+)$', views.poem_detail, name="poem_list"),
]