Django API接口之RestFrameWork

Django API接口之RestFrameWork

环境

系统:ubuntu18.04

安装

pip install django==2.1.5
pip install djangorestframework

基本API示例

创建django项目

django-admin startproject DjangoAPI

创建应用

cd DjangoAPI
python manage.py startapp api

项目代码

  • 修改settings.py,添加应用到配置中

    INSTALLED_APPS = [
        'django.contrib.admin',
        'django.contrib.auth',
        'django.contrib.contenttypes',
        'django.contrib.sessions',
        'django.contrib.messages',
        'django.contrib.staticfiles',
        'rest_framework',  # 添加rest_framework应用
        'api',  # 添加api应用
    ]
    
  • 执行数据库迁移

    python manage.py migrate
    
  • 创建管理员,会提示输入用户名:ubuntu,邮箱:ubuntu@ubuntu.com,密码:ubuntu123456

    python manage.py createsuperuser
    
  • 修改/api/models.py,创建数据库模型。

    from django.db import models
    
    
    class Student(models.Model):
        name = models.CharField(u'姓名', max_length=100, default='no_name')
        sex = models.CharField(u'性别', max_length=50, default='male')
        sid = models.CharField(u'学号', max_length=100, default='0')
    
        def __unicode__(self):
            return '%d: %s' % (self.pk, self.name) 
    

    创建模型后执行:

    python manage.py makemigrations # 生成数据库迁移文件
    python manage.py migrate # 执行数据库迁移
    
  • 修改/api/admin.py,写后台管理代码

    from django.contrib import admin
    from .models import Student
    
    
    @admin.register(Student)
    class BlogTypeAdmin(admin.ModelAdmin):
        list_display = ('pk', 'name')  # 在后台列表下显示的字段   
    
  • 运行项目

    python manage.py runserver
    

    出现如下内容表明成功:

    System check identified no issues (0 silenced).
    January 23, 2019 - 08:28:09
    Django version 2.1.5, using settings 'DjangoAPI.settings'
    Starting development server at http://127.0.0.1:8000/
    Quit the server with CONTROL-C.
    

    浏览器输入:

    http://127.0.0.1:8000/ # 出现django成功的界面
    http://127.0.0.1:8000/admin # 进入管理后台
    

    如图所示:
    在这里插入图片描述

  • 序列化模型类,在/api/下创建serializers.py,返回json数据

    from rest_framework import serializers
    from .models import Student
    
    
    class StudentSerializers(serializers.ModelSerializer):
        class Meta:
            model = Student  # 指定的模型类
            fields = ('pk', 'name', 'sex', 'sid',)  # 需要序列化的属性
    
  • 修改/api/views.py,视图

    from django.shortcuts import render
    from rest_framework import viewsets
    from .models import Student
    from .serializers import StudentSerializers
    # Create your views here.
    
    
    class StudentViewSet(viewsets.ModelViewSet):
        # 指定结果集并设置排序
        queryset = Student.objects.all().order_by('-pk')
        # 指定序列化的类
        serializer_class = StudentSerializers
    
  • 修改/urls.py/,配置主路由

    from django.contrib import admin
    from django.urls import path, include
    
    urlpatterns = [
        path('admin/', admin.site.urls),
        path('', include('api.urls')),  # 添加应用的路由地址
    ]
    
  • 在/api/下创建urls.py,配置应用路由

    from django.conf.urls import include, url
    from rest_framework import routers
    from api import views
    
    
    # 定义路由地址
    route = routers.DefaultRouter()
    
    # 注册新的路由地址
    route.register(r'student', views.StudentViewSet)
    
    # 注册上一级的路由地址并添加
    urlpatterns = [
        url('api/', include(route.urls)),
    ]
    
  • 运行项目

    python manage.py runserver
    

    打开浏览器输入:

    http://127.0.0.1:8000/api/ # api主页
    点击主页提供的链接http://127.0.0.1:8000/api/student/进入下一级目录
    

    如下图所示
    在这里插入图片描述
    在这里插入图片描述

  • 使用Postman测试工具测试api数据

    进入ubuntusoftware应用商店,搜索postman进行安装

    在postman中输入http://127.0.0.1:8000/api/student点击send,并返回json数据。

    如下图所示:

在这里插入图片描述

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值