创建一个应用程序,用于创建简单的Web API。
python manage.py startapp snippets
创建一个模型来处理
我们将首先创建一个Snippet用于存储代码片段的简单模型。继续并编辑snippets/models.py文件。
模型创建初始迁移,并首次同步数据库。
创建一个Serializer类
使用Web API的第一件事是提供一种将代码片段实例序列化和反序列化为表示形式的方法,例如json。我们可以通过声明与Django的表单非常相似的序列化程序来做到这一点。在snippets名为的目录中创建一个文件serializers.py并添加以下内容。
序列化程序类的第一部分定义了获得序列化/反序列化的字段。该create()和update()方法定义实例如何完全成熟的创建或修改时调用serializer.save()
序列化器类与Django Form类非常相似,并在各个字段中包含类似的验证标志,例如required,max_length和default。
字段标志还可以控制在某些情况下应该如何显示序列化程序,例如在呈现为HTML时。{'base_template': 'textarea.html'}上面的标志等同于widget=widgets.Textarea在Django Form类上使用。这对于控制如何显示可浏览的API特别有用,正如我们稍后在教程中看到的那样。
我们实际上也可以通过使用ModelSerializer该类节省一些时间,我们稍后会看到,但现在我们将保持我们的序列化器定义清晰。
使用串行器
在我们继续前进之前,我们将熟悉使用我们的新Serializer类。让我们进入Django shell。
python manage.py shell
此时我们已经将模型实例转换为Python本地数据类型。为了完成序列化过程,我们将数据渲染到json。
反序列化是相似的。首先我们将一个流解析为Python本地数据类型...
...然后我们将这些本地数据类型恢复为完全填充的对象实例。
注意API与表单的工作方式相似。当我们开始编写使用我们的序列化器的视图时,相似性应该变得更加明显。
我们也可以序列化查询集而不是模型实例。为此,我们只需many=True在序列化参数中添加一个标志。
使用ModelSerializers
我们SnippetSerializer班正在复制Snippet模型中包含的大量信息。如果我们可以保持我们的代码更简洁一点,那将是非常好的。
就像Django提供Form类和ModelForm类一样,REST框架包含Serializer类和ModelSerializer类。
让我们看看使用ModelSerializer该类重构我们的序列化程序。snippets/serializers.py再次打开该文件,并用SnippetSerializer下列内容替换该类。
class SnippetSerializer(serializers.ModelSerializer):
class Meta:
model = Snippet
fields = ('id', 'title', 'code', 'linenos', 'language', 'style')
序列化程序拥有的一个不错的属性是,您可以通过打印其表示来检查序列化程序实例中的所有字段。打开Django shell python manage.py shell,然后尝试以下操作:
重要的是要记住,ModelSerializer类不做任何特别神奇的事情,它们只是创建序列化程序类的捷径:
自动确定的一组字段。
简单的默认实现create()和update()方法。
使用我们的序列化程序编写常规的Django视图
让我们看看我们如何使用我们的新Serializer类编写一些API视图。目前我们不会使用任何REST框架的其他功能,我们只会将视图编写为常规的Django视图。
编辑该snippets/views.py文件,并添加以下内容。
from django.http import HttpResponse, JsonResponse
from django.views.decorators.csrf import csrf_exempt
from rest_framework.renderers import JSONRenderer
from rest_framework.parsers import JSONParser
from snippets.models import Snippet
from snippets.serializers import SnippetSerializer
我们的API的根源将成为支持列出所有现有片段或创建新片段的视图。
@csrf_exempt
def snippet_list(request):
"""
List all code snippets, or create a new snippet.
"""
if request.method == 'GET':
snippets = Snippet.objects.all()
serializer = SnippetSerializer(snippets, many=True)
return JsonResponse(serializer.data, safe=False)
elif request.method == 'POST':
data = JSONParser().parse(request)
serializer = SnippetSerializer(data=data)
if serializer.is_valid():
serializer.save()
return JsonResponse(serializer.data, status=201)
return JsonResponse(serializer.errors, status=400)
因为我们希望能够从不具有CSRF令牌的客户端向此视图发布POST,所以我们需要将视图标记为csrf_exempt。这不是你通常想要做的事情,而REST框架视图实际上使用比这更明智的行为,但它现在可以用于我们的目的。
我们还需要一个与单个片段相对应的视图,并可用于检索,更新或删除代码段。
@csrf_exempt
def snippet_detail(request, pk):
"""
Retrieve, update or delete a code snippet.
"""
try:
snippet = Snippet.objects.get(pk=pk)
except Snippet.DoesNotExist:
return HttpResponse(status=404)
if request.method == 'GET':
serializer = SnippetSerializer(snippet)
return JsonResponse(serializer.data)
elif request.method == 'PUT':
data = JSONParser().parse(request)
serializer = SnippetSerializer(snippet, data=data)
if serializer.is_valid():
serializer.save()
return JsonResponse(serializer.data)
return JsonResponse(serializer.errors, status=400)
elif request.method == 'DELETE':
snippet.delete()
return HttpResponse(status=204)
最后我们需要把这些观点联系起来。创建snippets/urls.py文件:
我们还需要在tutorial/urls.py文件中连接根urlconf 以包含我们的代码段应用的URL。
测试我们对Web API的第一次尝试
启动Django的开发服务器
在另一个终端窗口中,我们可以测试服务器。
我们可以使用curl或httpie来测试我们的API 。Httpie是用Python编写的用户友好的http客户端。让我们安装它。
您可以使用pip安装httpie:
可以通过引用其ID来获取特定片段: