我们将创建一个简单的 API,以允许管理员用户查看和编辑系统中的用户和组。
文章目录
- 一、项目设置
- 二、项目布局应如下所示:
- 三、序列化程序
- 四、视图
- 五、网址
- 六、分页
- 七、设置
- 八、测试我们的接口
一、项目设置
创建一个名为 的新 Django 项目,然后启动一个名为 的新应用程序。tutorial quickstart
# Create the project directory
mkdir tutorial
cd tutorial
# Create a virtual environment to isolate our package dependencies locally
python3 -m venv env
source env/bin/activate # On Windows use `env\Scripts\activate`
# Install Django and Django REST framework into the virtual environment
pip install django
pip install djangorestframework
# Set up a new project with a single application
django-admin startproject tutorial . # Note the trailing '.' character
cd tutorial
django-admin startapp quickstart
cd ..
二、项目布局应如下所示:
$ pwd
<some path>/tutorial
$ find .
.
./manage.py
./tutorial
./tutorial/__init__.py
./tutorial/quickstart
./tutorial/quickstart/__init__.py
./tutorial/quickstart/admin.py
./tutorial/quickstart/apps.py
./tutorial/quickstart/migrations
./tutorial/quickstart/migrations/__init__.py
./tutorial/quickstart/models.py
./tutorial/quickstart/tests.py
./tutorial/quickstart/views.py
./tutorial/asgi.py
./tutorial/settings.py
./tutorial/urls.py
./tutorial/wsgi.py
在项目目录中创建应用程序可能看起来很不寻常。使用项目的命名空间可避免与外部模块(该主题超出快速入门范围)发生名称冲突。
现在首次同步数据库:
python manage.py migrate
我们还将创建一个名为 的初始用户,其密码为 .稍后,我们将在示例中以该用户的身份进行身份验证。admin password123
python manage.py createsuperuser --email admin@example.com --username admin
一旦您设置了数据库并且创建了初始用户并准备就绪,打开应用程序的目录,我们将开始编码…
三、序列化程序
首先,我们将定义一些序列化程序。让我们创建一个名为的新模块,我们将用于数据表示。tutorial/quickstart/serializers.py
from django.contrib.auth.models import User, Group
from rest_framework import serializers
class UserSerializer(serializers.HyperlinkedModelSerializer):
class Meta:
model = User
fields = ['url', 'username', 'email', 'groups']
class GroupSerializer(serializers.HyperlinkedModelSerializer):
class Meta:
model = Group
fields = ['url', 'name']
请注意,在本例中,我们使用超链接关系。您也可以使用主键和各种其他关系,但超链接是很好的 RESTful 设计。HyperlinkedModelSerializer
四、视图
对,我们最好写一些观点。打开并打字。tutorial/quickstart/views.py
from django.contrib.auth.models import User, Group
from rest_framework import viewsets
from rest_framework import permissions
from tutorial.quickstart.serializers import UserSerializer, GroupSerializer
class UserViewSet(viewsets.ModelViewSet):
"""
API endpoint that allows users to be viewed or edited.
"""
queryset = User.objects.all().order_by('-date_joined')
serializer_class = UserSerializer
permission_classes = [permissions.IsAuthenticated]
class GroupViewSet(viewsets.ModelViewSet):
"""
API endpoint that allows groups to be viewed or edited.
"""
queryset = Group.objects.all()
serializer_class = GroupSerializer
permission_classes = [permissions.IsAuthenticated]
我们不是编写多个视图,而是将所有常见行为分组到称为 的类中。ViewSets
如果需要,我们可以轻松地将它们分解为单独的视图,但是使用视图集可以使视图逻辑井井有条且非常简洁。
五、网址
好的,现在让我们连接 API URL。tutorial/urls.py
from django.urls import include, path
from rest_framework import routers
from tutorial.quickstart import views
router = routers.DefaultRouter()
router.register(r'users', views.UserViewSet)
router.register(r'groups', views.GroupViewSet)
# Wire up our API using automatic URL routing.
# Additionally, we include login URLs for the browsable API.
urlpatterns = [
path('', include(router.urls)),
path('api-auth/', include('rest_framework.urls', namespace='rest_framework'))
]
因为我们使用的是视图集而不是视图,所以我们可以通过简单地将视图集注册到路由器类来自动生成 API 的 URL conf。
同样,如果我们需要对 API URL 进行更多控制,我们可以简单地下拉到使用常规的基于类的视图,并显式编写 URL conf。
最后,我们包括用于可浏览 API 的默认登录和注销视图。这是可选的,但如果 API 需要身份验证并且你想要使用可浏览的 API,则此功能非常有用。
六、分页
分页允许您控制每页返回多少个对象。要启用它,请将以下行添加到tutorial/settings.py
REST_FRAMEWORK = {
'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
'PAGE_SIZE': 10
}
七、设置
设置模块将位于'rest_framework'INSTALLED_APPStutorial/settings.py
INSTALLED_APPS = [
...
'rest_framework',
]
八、测试我们的接口
现在,我们已准备好测试我们构建的 API。让我们从命令行启动服务器。
python manage.py runserver
我们现在可以使用以下工具从命令行访问我们的 API…curl
bash: curl -H 'Accept: application/json; indent=4' -u admin:password123 http://127.0.0.1:8000/users/
{
"count": 2,
"next": null,
"previous": null,
"results": [
{
"email": "admin@example.com",
"groups": [],
"url": "http://127.0.0.1:8000/users/1/",
"username": "admin"
},
]
}
或者使用 httpie,命令行工具…
bash: http -a admin:password123 http://127.0.0.1:8000/users/
HTTP/1.1 200 OK
...
{
"count": 2,
"next": null,
"previous": null,
"results": [
{
"email": "admin@example.com",
"groups": [],
"url": "http://localhost:8000/users/1/",
"username": "paul"
},
]
}
或直接通过浏览器,通过转到 URL …http://127.0.0.1:8000/users/
如果您正在通过浏览器工作,请确保使用右上角的控件登录。
太好了,这很容易!