一. Django Rest Framework里面针对Django作的一些改进:
(一) 一些属性说明
Request对象中的属性:
request.POST #只针对POST 方法
request.data #对于任意类型的数据,不管是POST, PUT还是 PATCH
Response对象:
return Response(data) #渲染出客户端需要的数据格式
(二) 创建项目
#找一个自己的路径创建装项目的文件夹:
mkdir project
cd project
#创建一个名为helloworld的项目
django-admin startproject tutorial
cd tutorial
#创建一个名为quickstart的APP
python manage.py startapp snippets
#创建超级用户
python manage.py createsuperuser
#启动项目
python manage.py runserver
同时还要在settings.py里面加入rest_framwork
具体细节参考上一篇博客,这里不赘述了。
如果不想新建项目,可以直接拷贝第一级别的代码,然后改以下文件:
二. snippets/views.py
使用的是函数式视图,现在已经不推荐了。 Anyway, 我们一步一步来,看看现在的django rest framework是怎么慢慢进化的. ok, let’s move on…
from rest_framework import status
from rest_framework.decorators import api_view
from rest_framework.response import Response
from snippets.models import Snippet
from snippets.serializers import SnippetSerializer
@api_view(['GET', 'POST'])
def snippet_list(request, format=None):
"""
列表和创建
"""
if request.method == 'GET':
snippets = Snippet.objects.all()
serializer = SnippetSerializer(snippets, many=True)
return Response(serializer.data)
elif request.method == 'POST':
serializer = SnippetSerializer(data=request.data)
if serializer.is_valid():
serializer.save()
return Response(serializer.data, status=status.HTTP_201_CREATED)
return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
@api_view(['GET', 'PUT', 'DELETE'])
def snippet_detail(request, pk, format=None):
"""
详情,修改和删除
"""
try:
snippet = Snippet.objects.get(pk=pk)
except Snippet.DoesNotExist:
return Response(status=status.HTTP_404_NOT_FOUND)
if request.method == 'GET':
serializer = SnippetSerializer(snippet)
return Response(serializer.data)
elif request.method == 'PUT':
serializer = SnippetSerializer(snippet, data=request.data)
if serializer.is_valid():
serializer.save()
return Response(serializer.data)
return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
elif request.method == 'DELETE':
snippet.delete()
return Response(status=status.HTTP_204_NO_CONTENT)
- 对于函数式, 使用装饰器@api_view, 如:@api_view([‘GET’,‘POST’]),对于类,使用APIView。都是起到限制的作用,只会使用里面包含的方法, 比如
@api_view(['GET', 'POST'])
, 如果去掉[‘GET’, ‘POST’]中的POST
,那么就无法实现创建的功能。如果去掉GET就无法看到列表。 - request.data不仅能处理客户端传来的json格式数据,也可以处理其它格式的数据
- return Response表示渲染出客户端需要的数据格式,用format=None明确指出可以返回客户端指定的格式数据,比如可以处理这种请求:http://example.com/api/items/4.json
三. snippets/urls.py和tutorial/urls.py
(一)tutorial/urls.py
from django.contrib import admin
from django.urls import path, include
urlpatterns = [
path('admin/', admin.site.urls),
path('', include('snippets.urls')),
]
(二) snippets/urls.py
from django.urls import path
from rest_framework.urlpatterns import format_suffix_patterns
from snippets import viewstutorial/urls.py
urlpatterns = [
path('snippets/', views.snippet_list),
path('snippets/<int:pk>', views.snippet_detail),
]
urlpatterns = format_suffix_patterns(urlpatterns)
上面用到format_suffix_patterns,这个是定义url的后缀的,与views.py里面的format相对应.也就是说要在urls.py里面使用format_suffix_patterns的话,在views.py里面必须要有format关键字参数!比如如下的请求就是由format_suffix_patterns
来实现的。
http http://127.0.0.1:8000/snippets.json # JSON 后缀,返回的数据格式是json格式
详情请查看:
https://blog.csdn.net/Fweiren/article/details/85339048
完成!!
接下来让我们看一下长啥样:
- 启动项目
python manage.py runserver
- 在另一个terminal执行一下操作
#访问列表
http http://127.0.0.1:8000/snippets/
HTTP/1.1 200 OK
...
[
{
"id": 1,
"title": "",
"code": "foo = \"bar\"\n",
"linenos": false,
"language": "python",
"style": "friendly"
},
{
"id": 2,
"title": "",
"code": "print(\"hello, world\")\n",
"linenos": false,
"language": "python",
"style": "friendly"
}
]
# 用Accept来指定返回的结果为Request JSON格式
http http://127.0.0.1:8000/snippets/ Accept:application/json
# 或者采用后缀来指定返回格式
http http://127.0.0.1:8000/snippets.json # JSON 后缀
# 用Accept来指定返回的结果为Request HTML格式
http http://127.0.0.1:8000/snippets/ Accept:text/html
http http://127.0.0.1:8000/snippets.api # Browsable API 后缀
# 对于post过去的数据可以控制数据的格式
# POST using form data(使用form data格式进行post)
http --form POST http://127.0.0.1:8000/snippets/ code="print(123)"
{
"id": 3,
"title": "",
"code": "print(123)",
"linenos": false,
"language": "python",
"style": "friendly"
}
# POST using JSON(使用json格式进行post)
http --json POST http://127.0.0.1:8000/snippets/ code="print(456)"
{
"id": 4,
"title": "",
"code": "print(456)",
"linenos": false,
"language": "python",
"style": "friendly"
}
同时可以查看: http://127.0.0.1:8000/snippets/ 这样会比较直观
我们的Django-Rest-Framework第二级别的项目到此就结束了,希望对你有所帮助噢。以上!
ps: