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中atexit模块的基本使用示例
Jul 08 Python
详解Python 模拟实现生产者消费者模式的实例
Aug 10 Python
python遍历文件夹下所有excel文件
Jan 03 Python
Django使用 Bootstrap 样式修改书籍列表过程解析
Aug 09 Python
python GUI库图形界面开发之PyQt5线程类QThread详细使用方法
Feb 26 Python
python实现程序重启和系统重启方式
Apr 16 Python
在Windows上安装和配置 Jupyter Lab 作为桌面级应用程序教程
Apr 22 Python
Python实现发票自动校核微信机器人的方法
May 22 Python
python PIL模块的基本使用
Sep 29 Python
python3排序的实例方法
Oct 20 Python
接口自动化多层嵌套json数据处理代码实例
Nov 20 Python
pycharm 如何查看某一函数源码的快捷键
May 12 Python
Python基础之变量的相关知识总结
Jun 23 #Python
浅谈Python数学建模之固定费用问题
浅谈Python数学建模之整数规划
浅谈Python数学建模之数据导入
Jun 23 #Python
python四种出行路线规划的实现
浅谈Python数学建模之线性规划
Jun 23 #Python
教你如何用Python实现人脸识别(含源代码)
You might like
PHP Global定义全局变量使用说明
2013/08/15 PHP
PHP入门经历和学习过程分享
2014/04/11 PHP
跟我学Laravel之请求(Request)的生命周期
2014/10/15 PHP
php通过strpos查找字符串出现位置的方法
2015/03/17 PHP
再推荐十款免费的php开发工具
2015/11/09 PHP
Yii2中使用join、joinwith多表关联查询
2016/06/30 PHP
Jquery 获得服务器控件值的方法小结
2010/05/11 Javascript
JavaScript中常用的运算符小结
2012/01/18 Javascript
Jquery和JS用外部变量获取Ajax返回的参数值的方法实例(超简单)
2013/06/17 Javascript
js实现连续英文字符自动换行兼容ie6 ie7和firefox
2013/09/06 Javascript
jQuery使用slideUp方法实现控制元素缓慢收起
2015/03/27 Javascript
javascript+HTML5的Canvas实现Lab单车动画效果
2015/08/07 Javascript
jQuery实现div拖拽效果实例分析
2016/02/20 Javascript
JavaScript+html5 canvas实现图片破碎重组动画特效
2016/02/22 Javascript
js阻止浏览器默认行为触发的通用方法(推荐)
2016/05/15 Javascript
分享JS数组求和与求最大值的方法
2016/08/11 Javascript
jquery.uploadifive插件怎么解决上传限制图片或文件大小问题
2017/05/08 jQuery
使用travis-ci如何持续部署node.js应用详解
2017/07/30 Javascript
微信小程序 POST请求的实例详解
2017/09/29 Javascript
AngularJS监听ng-repeat渲染完成的两种方法
2018/01/16 Javascript
浅谈实现vue2.0响应式的基本思路
2018/02/13 Javascript
发布一款npm包帮助理解npm的使用
2019/01/03 Javascript
webpack4手动搭建Vue开发环境实现todoList项目的方法
2019/05/16 Javascript
js如何实现元素曝光上报
2019/08/07 Javascript
JavaScript实现商品评价五星好评
2020/11/30 Javascript
python实现的文件夹清理程序分享
2014/11/22 Python
Python检查ping终端的方法
2019/01/26 Python
详解pandas删除缺失数据(pd.dropna()方法)
2019/06/25 Python
Django+Django-Celery+Celery的整合实战
2021/01/20 Python
CSS3 渐变(Gradients)之CSS3 径向渐变
2016/07/08 HTML / CSS
让IE下支持Html5的placeholder属性的插件
2014/09/02 HTML / CSS
竞争上岗演讲稿
2014/01/05 职场文书
书香校园建设方案
2014/05/02 职场文书
高等教育学专业自荐书
2014/06/17 职场文书
安全教育主题班会总结
2015/08/14 职场文书
图神经网络GNN算法
2022/05/11 Python