Django REST Framework介绍

1.Django REST framework框架介绍

  • Django REST framework框架是一个功能强大且灵活的工具包,用于构建Web API,且Django Rest Framework 是 Django 依赖扩展 Restful Api 的框架,与Django的使用风格相似,它的官方网站是:https://www.django-rest-framework.org/

2.设计API

咱们先选择一个APP,好比说我选择的是schools APP,如何在设计这个APP中设计一个API接口,且在前端请求的时候,返回数据库中全部学校的详细信息呢?html

  • 第一步:首先须要在项目的urls.py文件(根路由)中添加二级路由;
url(r'^school/', include('schools.urls', namespace='schools'))
  • 第二步:在schools APP中的urls.py文件添加路由,指定访问路径,须要导入AllSchoolsView类,AllSchoolsView类是在view.py文件中编写,(记得执行makemigration 和 migrate操做)
url(r'^all/$', AllSchoolsView.as_view(), name='all')
  • 第三步:在schools APP中的views.py文件中,编写AllSchoolsView类
from django.views.generic.base import View
import json
from django.core.serializers import serialize
from django.http import HttpResponse, JsonResponse
from .models import School

class AllSchoolsView(View):
    def get(self, request):
        schools = School.objects.all()
        # 直接将数据库中的QuerySet对象转换为json数据格式
        goods_json = serialize('json', schools)
        print(type(goods_json))
        print('serialize: --------{}'.format(goods_json))
        return HttpResponse(content=goods_json, content_type='application/json')
  • 第四步:在schools APP中的models.py文件中,根据需求建立schools_school表;
from django.db import models
from datetime import datetime

class School(models.Model):
    name = models.CharField(max_length=50, verbose_name='学校名称')
    desc = models.CharField(max_length=100, verbose_name='学校描述')
    location = models.CharField(max_length=100, verbose_name='学校位置')
    create_time = models.DateTimeField(default=datetime.now, verbose_name='添加时间')
    course_numbers = models.IntegerField(default=0, verbose_name="课程数")

建立数据库表前面的文章也讲过,这里就不讲了,数据库表建立好了以后咱们能够往里面增长数据,可使用命令行添加,可是这样比较麻烦,因此这里咱们数据库管理和设计工具Navicat(文章最后介绍),使用这个工具咱们能够手动增长修改数据库表中的数据,特别方便; 首先须要选择一个待使用的数据库,我使用的是MySql,而后建立链接,再填写一下选项就能够了:前端

1.png

2.png

3.png

  • 第五步:建立数据库中schools_school表的数据,能够经过Navicat来操做数据库,最后咱们的数据库表示这样的:

4.png

  • 第六步:运行项目,就能获得咱们想要的json数据了,访问路径是http://127.0.0.1:8000/schools/all/

3.使用Django REST framework定制Restful API

  • 第一步:首先安装好须要用到的包;
pip install djangorestframework
pip install markdown       # Markdown support for the browsable API.
pip install django-filter  # Filtering support
  • 第二步:而后在项目的settings文件的INSTALLED_APPS中添加rest_framewor;
INSTALLED_APPS = (
    'rest_framework',
)
  • 第三步:在根路由urls.py中加一条路由,用于支持浏览器访问api认证;
url(r'^api-auth/', include('rest_framework.urls'))
  • 第四步:建立Django的管理员,选择Tool->Run manage.py Task而后执行createsuperuser,编辑本身的用户名、邮箱和密码就能够了;数据库

  • 第五步:在schools APP中建立serializer.py文件,在这个文件中导入serializers模块,而后建立一个序列化类(本身命名),让这个类继承serializers模块下的Serializer类;django

from rest_framework import serializers
class SchoolSerializer(serializers.Serializer):
    name = serializers.CharField()
    course_numbers = serializers.IntegerField()
  • 第六步:在schools APP中的views.py文件中重写AllSchoolsView类,重启服务器就能获得Django REST framework返回的数据了;
from .models import School
from rest_framework.views import APIView
from rest_framework.response import Response
from .serializer import SchoolSerializer

class AllSchoolsView(APIView):
    def get(self, request):
        schools = School.objects.all()
        # many表示返回一个list, 若是不设置,则返回一个
        schools_serializer = SchoolSerializer(schools, many=True)
        return Response(schools_serializer.data)

5.png

4.Navicat

  • Navicat是一套可建立多个链接的数据库管理工具,用以方便管理 MySQL、Oracle、 PostgreSQL、SQLite、SQL Server、MariaDB 和/或 MongoDB 等不一样类型的数据库,并 支持管理某些云数据库,例如阿里云、腾讯云;json

  • Navicat 提供了三种平台的版本Windows、macOS 、Linux,可让用户链接到本地或远 程服务器,并提供一些实用的数据库工具以协助用户管理数据,包括 Navicat Cloud 协同合 做、数据建模、数据传输、数据同步、结构同步、导入、导出、备份、还原和自动运行;api

  • 想了解更多用法能够查看官网,官网地址:https://www.navicat.com/en/浏览器

参考:https://www.9xkd.com/user/plan-view.html?id=7558399250服务器

相关文章
相关标签/搜索