咱们将建立一个简单的API来容许管理员用户查看和编辑系统中的用户和组。python
建立一个新的django项目，命名为：<tutorial>，而后建立一个新的应用程序(app)，命名为：<quickstart>。web
# Create the project directory数据库
mkdir tutorialdjango
cd tutorialjson
# Create a virtual environment to isolate our package dependencies locallyapi
python3 -m venv env浏览器
source env/bin/activate # On Windows use `env\Scripts\activate`bash
# Install Django and Django REST framework into the virtual environmentapp
pip install djangocurl
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/settings.py
./tutorial/urls.py
./tutorial/wsgi.py
这个项目目录看起来有不太同样，它的应用程序创建在项目目录内。使用项目的命名空间能够避免和外部模块发生命名冲突（这个话题超出了本文章的讨论范围）。
如今，能够开始同步咱们的数据库了。
python manage.py migrate
一样。咱们还须要建立一个初始用户，并将其命名为：<admin>。将密码设置为：<password123>。
python manage.py createsuperuser --email admin@example.com --username admin
当你设置好数据库，初始用户建立完成后，打开应用程序<quickstart>目录，而后就能够开始写代码啦~
第一步咱们将定义一些序列化工具(serializers)。让咱们建立一个新的模块。命名为：<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']
注意咱们如今使用的序列化工具<UserSerializer>和<GroupSerializer>都继承至<HyperlinkedModelSerializer>这个父类。这个父类容许咱们以超连接的方式来描述数据表之间的关系。你也可使用主键<primary key>或者其余方式来关联数据表之间的关系，可是使用超连接这种设计方式是很是符合RESTful1设计的。
第二步。咱们须要搞定视图部分了。打开<tutorial/quickstart/views.py>，而后开始写代码吧~
from django.contrib.auth.models import User, Group
from rest_framework import viewsets
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
class GroupViewSet(viewsets.ModelViewSet):
"""
API endpoint that allows groups to be viewed or edited.
"""
queryset = Group.objects.all()
serializer_class = GroupSerializer
咱们经过类<ViewSets>这个类，将视图函数中功能一致的部分都整合到一块儿。这样就不须要写不少的视图函数了。
固然， 在一些须要自定义的状况下咱们也能够轻易地将整合好的视图分离，可是使用<ViewSets>可让咱们的逻辑整理的更加清晰同时代码也更加简洁。
接下来咱们该设置咱们的API路由了。打开<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'))
]
由于咱们使用<ViewSets>实例替代了原始的视图，这让咱们能够经过在<DefaultRouter>的实例中，中注册咱们的<ViewSets>实例便可自动地为咱们生成相应的路由。
固然，若是咱们但愿自定义路由使其功能更加丰富，也能够抛弃这个功能转而使用普通的基于类的视图，而后定义路由。
最后一步，将用户登陆和登出视图放置在了可浏览的API页面内。这是一个可选择项，若是你的须要使用可浏览的API页面和用户管理。
分页功能让你能够控制每页显示多少个对象。要使用它的话请在文件<tutorial/settings.py>内添加如下代码：
REST_FRAMEWORK = {
'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
'PAGE_SIZE': 10
}
打开设置模块<tutorial/settings.py>，将<’rest_framework’>添加到<INSTALLED_APPS>。以下：
INSTALLED_APPS = [
...
'rest_framework',
]
以上，咱们已经作完了。一个简单的用户管理API，而且能够在浏览器上快速访问，测试的API。看完以上东西你可能会想：”wtf？？？！！！。这是什么东西？”。接下来咱们将作一些测试，来帮助你理解。咱们到底作了个什么的东西。
如今咱们能够开始测试刚刚搭建好的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"
},
{
"email": "tom@example.com",
"groups": [ ],
"url": "http://127.0.0.1:8000/users/2/",
"username": "tom"
}
]
}
或者使用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"
},
{
"email": "tom@example.com",
"groups": [ ],
"url": "http://127.0.0.1:8000/users/2/",
"username": "tom"
}
]
}
或者直接使用浏览器。打开连接：http://127.0.0.1:8000/users/
若是你是经过浏览器访问的，你须要在右上角登陆。由于这个管理工具是给admin用的。游客没法访问。
若是还要深刻学习和理解REST framework是如何将这些功能一步一步封装到一块儿的。请继续收看以后的指导文章，或者直接阅读咱们的API。
以上就是本文所有内容，若是你看不懂，那大概须要用django再作几个小项目来熟悉一下django web应用的业务流程。