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实现二叉堆
Feb 03 Python
浅谈python中scipy.misc.logsumexp函数的运用场景
Jun 23 Python
解决python使用open打开文件中文乱码的问题
Dec 29 Python
python批量导入数据进Elasticsearch的实例
May 30 Python
详解多线程Django程序耗尽数据库连接的问题
Oct 08 Python
Python中collections模块的基本使用教程
Dec 07 Python
Python实现Linux监控的方法
May 16 Python
Python OrderedDict的使用案例解析
Oct 25 Python
python dict如何定义
Sep 02 Python
Django多数据库联用实现方法解析
Nov 12 Python
python输出国际象棋棋盘的实例分享
Nov 26 Python
Python用requests库爬取返回为空的解决办法
Feb 21 Python
Python基础之变量的相关知识总结
Jun 23 #Python
浅谈Python数学建模之固定费用问题
浅谈Python数学建模之整数规划
浅谈Python数学建模之数据导入
Jun 23 #Python
python四种出行路线规划的实现
浅谈Python数学建模之线性规划
Jun 23 #Python
教你如何用Python实现人脸识别(含源代码)
You might like
一个很方便的 XML 类!!原创的噢
2006/10/09 PHP
PHP邮件专题
2006/10/09 PHP
PHP4实际应用经验篇(5)
2006/10/09 PHP
PHP遍历目录并返回统计目录大小
2014/06/09 PHP
php生成年月日下载列表的方法
2015/04/24 PHP
浅谈PHP封装CURL
2019/03/06 PHP
Laravel如何自定义command命令浅析
2019/03/23 PHP
PHP与Web页面的交互示例详解一
2020/08/04 PHP
jQuery 1.5.1 发布,全面支持IE9 修复大量bug
2011/02/26 Javascript
jQuery源码分析-01总体架构分析
2011/11/14 Javascript
动态加载js、css等文件跨iframe实现
2014/02/24 Javascript
JavaScript判断一个字符串是否包含指定子字符串的方法
2015/03/18 Javascript
javascript原型继承工作原理和实例详解
2016/04/07 Javascript
微信小程序中的onLoad详解及简单实例
2017/04/05 Javascript
vue-router单页面路由
2017/06/17 Javascript
react 父组件与子组件之间的值传递的方法
2017/09/14 Javascript
jquery ajax异步提交表单数据的方法
2017/10/27 jQuery
vue视图不更新情况详解
2019/05/16 Javascript
JS实现移动端点击按钮复制文本内容
2019/07/28 Javascript
vue resource发送请求的几种方式
2019/09/30 Javascript
微信小程序实现加入购物车滑动轨迹
2020/11/18 Javascript
js调用网络摄像头的方法
2020/12/05 Javascript
使用Pytorch来拟合函数方式
2020/01/14 Python
Python学习之路之pycharm的第一个项目搭建过程
2020/06/18 Python
Python基于time模块表示时间常用方法
2020/06/18 Python
举例详解CSS3中的Transition
2015/07/15 HTML / CSS
html5 web本地存储将取代我们的cookie
2012/12/26 HTML / CSS
巴西最大的家具及装饰用品店:Mobly
2017/10/11 全球购物
北卡罗来纳州豪华家具和家居装饰店:Carolina Rustica
2018/10/30 全球购物
Mountain Warehouse波兰官方网站:英国户外品牌
2019/08/29 全球购物
俄罗斯茶和咖啡网上商店:Tea.ru
2021/01/26 全球购物
优秀学生自我鉴定范例
2013/12/18 职场文书
会计毕业生自荐书
2014/06/12 职场文书
留学推荐信怎么写
2015/03/26 职场文书
nginx实现动静分离的方法示例
2021/11/07 Servers
Android超详细讲解组件ScrollView的使用
2022/03/31 Java/Android