Python django中如何使用restful框架


Posted in Python onJune 23, 2021

在使用django进行前后台分离开发时通常会搭配django-rest-framework框架创建RESTful风格的接口API。框架介绍及版本要求可参考官方地址:https://www.django-rest-framework.org

Python django中如何使用restful框架

本文以创建man包含namesex字段的API为实例学习django-rest-framework框架的使用。

主要包含下面5个步骤:

1.创建Django项目

2.创建ORM模型

3.加载Django REST Framework

4.序列化模型

5.创建加载数据的view和url

1.创建Django项目

创建django_rest

 

django-admin startproject django_rest

进入django_rest,创建虚拟环境env

 

virtualenv env

激活虚拟环境,并安装django

 

source ./env/bin/activate

安装 django

 

pip install django

创建rest_app

 

python manage.py startapp rest_app

注册app,将app添加到INSTALLED_APPS

 

#setting.py

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'rest_app'
]

创建后台admin账户用于管理

 

$ python manage.py createsuperuser

Username (leave blank to use 'root'):admin 
Email address: 
Password: 
Password (again): 
Superuser created successfully.

2.创建ORM模型

数据库我们使用默认sqlite3 即可,如需要变更可在setting.py中databases配置。

修改我们/django_rest/models.py添加我们man的模型

 

#models.py

from django.db import models



# Create your models here.
class Man(models.Model):
    name = models.CharField(max_length=64)
    sex = models.CharField(max_length=64)

    def __str__(self):
        return self.name

做数据库迁移

 

python manage.py makemigrations 
python manage.py migrate

Python django中如何使用restful框架

将Man这个model注册到我们的后台,以便可以通过django的后台做增删查改,编写admin.py如下

 

#admin.py
from django.contrib import admin
from .models import Man
# Register your models here.

admin.site.register(Man)  # 注册Man到后台

启动django服务

 

python manage.py runserver

访问 http://127.0.0.1:8000/admin/可以看到登录界面,输入密码登录

Python django中如何使用restful框架

可以看到我们的rest_app下的模型man对象mans

Python django中如何使用restful框架

我们添加一个那个男人lgd.ame

Python django中如何使用restful框架

3. 加载Django REST Framework

安装工具包

 

pip install djangorestframework

注册rest_framework

 

#setting.py
INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'rest_app'
    'rest_framework' #注册
]

4.序列化模型

序列化器会把我们的模型数据转化(序列化)为json格式,这样就能够被请求了。同样当有josn数据提交过来的时候,序列化器会将json数据转换为模型供咋们使用。

我们在rest_app下创建文件serializer.py

我们要做三件事:

1.导入Man模型

2.导入序REST Framework序列化器

3.创建新的类将模型和序列化器链接起来

from rest_framework import serializers

from .models import Man

class Manserializer(serializers.HyperlinkedModelSerializer):
    class Meta:
        model = Man
        fields = ('name','sex')

5.创建加载数据的view和url

我们需要把序列化后的数据返回给浏览器,所以要做一下步骤:

1.通过不通的Man查询数据库

2.将查询后的数据传递给序列化器,通过序列化器转化为json

我们在rest_app/views.py编写我们的视图,ModelViewSet由rest_framework提供,包含了get、post方法

 

# views.py
from rest_framework import viewsets

from .serializers import ManSerializer
from .models import Man


class ManViewSet(viewsets.ModelViewSet):
    queryset = Man.objects.all().order_by('name')  #查询结果给queryset
    serializer_class = ManSerializer     #对结果进序列化

在django_rest目录下urls.py添加api路由

 

from django.contrib import admin
from django.urls import path, include

urlpatterns = [
    path('admin/', admin.site.urls),
    path('', include('rest_app.urls')),
 ]

在rest_app目录下创建urls.py添加视图路由,通过rest_framework中router确保我们的请求到正确的动态资源。

 

from django.urls import include, path
from rest_framework import routers
from . import views

router = routers.DefaultRouter()
router.register(r'man', views.ManViewSet)   #路由到ManViewSet视图

# Wire up our API using automatic URL routing.
# Additionally, we include login URLs for the browsable API.
urlpatterns = [
    path('', include(router.urls)), #使用router路由
    path('api-auth/', include('rest_framework.urls', namespace='rest_framework'))
]

最后我们来启动服务,访问http://127.0.0.1:8000/ 可以在浏览器查看到我们api信息

 

python manage.py runserver

Python django中如何使用restful框架

访问http://127.0.0.1:8000/man/ 来查看man资源

Python django中如何使用restful框架

通过id来访问api资源http://127.0.0.1:8000/man/1/

Python django中如何使用restful框架

这样我们一个基础restful风格的API创建完成了。感觉关键点还是理解ModelViewSet和内置router不读源码很难知其所以然。

到此这篇关于Python django中如何使用restful框架的文章就介绍到这了,更多相关restful框架的使用内容请搜索三水点靠木以前的文章或继续浏览下面的相关文章希望大家以后多多支持三水点靠木!

Python 相关文章推荐
python回溯法实现数组全排列输出实例分析
Mar 17 Python
python遍历数组的方法小结
Apr 30 Python
Python 中pandas.read_excel详细介绍
Jun 23 Python
利用python爬取斗鱼app中照片方法实例
Dec 03 Python
python 运用Django 开发后台接口的实例
Dec 11 Python
python 切换root 执行命令的方法
Jan 19 Python
OpenCV+face++实现实时人脸识别解锁功能
Aug 28 Python
python opencv将表格图片按照表格框线分割和识别
Oct 30 Python
keras实现多种分类网络的方式
Jun 11 Python
Python使用eval函数执行动态标表达式过程详解
Oct 17 Python
python查询MySQL将数据写入Excel
Oct 29 Python
Python创建自己的加密货币的示例
Mar 01 Python
Python基础之变量的相关知识总结
Jun 23 #Python
浅谈Python数学建模之固定费用问题
浅谈Python数学建模之整数规划
浅谈Python数学建模之数据导入
Jun 23 #Python
python四种出行路线规划的实现
浅谈Python数学建模之线性规划
Jun 23 #Python
教你如何用Python实现人脸识别(含源代码)
You might like
2019年中国咖啡业现状与发展趋势
2021/03/04 咖啡文化
php中memcache 基本操作实例
2015/05/17 PHP
初识通用数据库操作类――前端easyui-datagrid,form(php)
2015/07/31 PHP
网页的分页下标生成代码(PHP后端方法)
2016/02/03 PHP
PHP receiveMail实现收邮件功能
2018/04/25 PHP
为javascript添加String.Format方法
2020/08/11 Javascript
js压缩工具 yuicompressor 使用教程
2010/03/31 Javascript
JS获取URL中的参数数据
2013/12/05 Javascript
javascript读写json示例
2014/04/11 Javascript
js统计录入文本框中字符的个数并加以限制不超过多少
2014/05/23 Javascript
js的window.showModalDialog及window.open用法实例分析
2015/01/29 Javascript
jquery淡入淡出效果简单实例
2016/01/14 Javascript
JS实现消息来时让网页标题闪动效果的方法
2016/04/20 Javascript
jQuery基于ajax实现页面加载后检查用户登录状态的方法
2017/02/10 Javascript
简单实现js上传文件功能
2017/08/21 Javascript
Node做中转服务器转发接口
2017/10/18 Javascript
vue.js 实现点击按钮动态添加li的方法
2018/09/07 Javascript
js 判断当前时间是否处于某个一个时间段内
2019/09/19 Javascript
JavaScript碰撞检测原理及其实现代码
2020/03/12 Javascript
详解Vue之计算属性
2020/06/20 Javascript
Python抓取Discuz!用户名脚本代码
2013/12/30 Python
举例详解Python中threading模块的几个常用方法
2015/06/18 Python
python中urllib.unquote乱码的原因与解决方法
2017/04/24 Python
mac安装scrapy并创建项目的实例讲解
2018/06/13 Python
python 定时任务去检测服务器端口是否通的实例
2019/01/26 Python
PyInstaller将Python文件打包为exe后如何反编译(破解源码)以及防止反编译
2020/04/15 Python
python中pyqtgraph知识点总结
2021/01/26 Python
在canvas上实现元素图片镜像翻转动画效果的方法
2018/03/20 HTML / CSS
JVM是一个编译程序还是解释程序
2012/09/11 面试题
化学教师自荐信范文
2013/12/28 职场文书
门面房租房协议书
2014/12/01 职场文书
从严治党主题教育活动总结
2015/05/07 职场文书
导游词之襄阳古城
2019/09/27 职场文书
2020年元旦晚会策划书模板
2019/12/30 职场文书
微信小程序scroll-view不能左右滑动问题的解决方法
2021/07/09 Javascript
详解CSS中的特指度和层叠问题
2021/07/15 HTML / CSS