Python 如何开发出RESTful Web接口,DRF框架助力灵活实现!

简介: Python 如何开发出RESTful Web接口,DRF框架助力灵活实现!

Django Rest Framework(DRF)是构建强大且灵活的Web API的优秀工具。它基于Django,提供了一套用于构建Web API的组件和工具,简化了API开发过程,同时保留了Django的优雅和强大。


一、Web应用模式


在开发Web应用时,通常有两种开发模式。


1、前后端不分离


前端页面看到的效果都是由后端控制,由后端渲染页面或重定向,前端与后端的耦合度很高。


这种应用模式比较适合纯网页应用,但是当后端对接App时,App可能并不需要后端返回一个HTML网页,而仅仅是数据本身,所以后端原本返回网页的接口不再适用于前端App应用,为了对接App后端还需再开发一套接口。


2、前后端分离


后端仅返回前端所需的数据,不再渲染HTML页面,不再控制前端的效果。


至于前端用户看到什么效果,从后端请求的数据如何加载到前端中,都由前端自己决定,网页有网页的处理方式,App有App的处理方式,但无论哪种前端,所需的数据基本相同,后端仅需开发一套逻辑对外提供数据即可。

前后端分离模式优点:

  • 提升开发效率
  • 完美应对复杂多变的前端需求
  • 增强代码可维护性


二、什么是API 接口?


API(应用程序接口)是一组定义了软件组件如何互相交互的规范。


API 是一些功能、定义或者协议的集合,通过 API 接口实现计算机软件之间的相互通信。对外封装完善,调用时无需学习 API 内部源码,依据 API 文档功能说明书来使用即可。


API 同时也是一种中间件,为各种不同平台提供数据共享。


API接口的数据格式有哪些?


目前 API 接口支持 XLSX、JSON、XML、CSV、RDF 等数据格式,其中 JSON 和 XML 是主流的数据格式,几乎所有 API 接口都支持这两种数据格式。

RESTful API 是一种基于REST架构风格设计的API。它使用统一的接口和状态无关的通信方式来实现各种网络应用。这种设计风格使得RESTful API具有简单、灵活、可扩展和易于理解的特点,因此在Web开发中得到了广泛的应用。


Django Rest Framework 正是基于Rest架构风格设计的一款 后端API 框架。


三、RESTful API


RESTful 是一种定义 Web API 接口的设计风格,尤其适用于前后端分离的应用模式中。

这种风格的理念认为后端开发任务就是提供数据的,对外提供的是数据资源的访问接口,所以在定义接口时,客户端访问的URL路径就表示这种要操作的数据资源。


事实上,我们可以使用任何一个框架都可以实现符合restful规范的API接口。


1、数据安全


RESTful API 链接一般都采用https协议进行传输,以提高数据交互过程中的安全性。


2、接口特征


通常用api关键字标识接口url。

https://api.github.io/
https://github.io/api

3、多数据版本共存


在url链接中标识数据版本。

https://api.github.io/v1
https://github.io/api/v2

注:url链接中的v1、v2就是不同数据版本的体现(一种数据资源有多版本情况下,也适用于新旧版本间)


4、数据即是资源,均使用名词(可复数)


接口一般都是完成前后台数据的交互,交互的数据我们称之为资源。

https://api.github.io/v1/users

注:一般提倡用资源的复数形式,在url链接中千万不要出现操作资源的动词

错误示范:https://api.github.io/v1/delete-user

特殊的接口可以出现动词,因为这些接口一般没有一个明确的资源,或是动词就是接口的核心含义

https://api.github.io/login

5、资源操作由请求方式决定

操作资源一般都会涉及到增删改查,我们提供请求方式来标识增删改查动作。

https://api.github.io/users - get请求:获取所有用户
https://api.github.io/users/1 - get请求:获取ID为1的用户
https://api.github.io/users - post请求:新增一个用户
https://api.github.io/users/1 - put请求:整体修改ID为1的用户
https://api.github.io/users/1 - patch请求:局部修改ID为1的用户
https://api.github.io/users/1 - delete请求:删除ID为1的用户

6、通过在url上传参的形式传递搜索条件

https://api.github.io/v1/projects?page=5&per_page=10  指定第几页,以及每页的记录数

7、错误处理,应返回错误信息

{
    error: "服务器发生错误"
}

四、Django Rest Framework


1、DRF 简介


Django REST framework 是一个建立在Django基础之上的Web 应用开发框架,可以快速的开发REST API接口应用。

DRF优点:

  • 提供了定义序列化器Serializer的方法,可以快速根据 Django ORM 或者其它库自动序列化/反序列化;
  • 提供了丰富的类视图、Mixin扩展类,简化视图的编写;
  • 丰富的定制层级:函数视图、类视图、视图集合到自动生成 API,满足各种需要;
  • 多种身份认证和权限认证方式的支持 JWT;
  • 内置了限流系统;
  • 直观的 API web 界面;
  • 可扩展性,插件丰富


2、安装和设置


首先,确保你的项目已经安装了Django。然后,使用以下命令安装DRF:

pip install djangorestframework

接下来,在你的Django项目的settings.py中添加以下行:

INSTALLED_APPS = [
    # ...
    'rest_framework',
]

然后,配置你的URL以包含DRF的路由:

from django.urls import path, include
urlpatterns = [
    # ...
    path('api/', include('rest_framework.urls')),
]

3、创建一个简单的API视图


现在,我们来创建一个简单的API视图。首先,定义一个序列化器:

from rest_framework import serializers
class MyModelSerializer(serializers.ModelSerializer):
    class Meta:
        model = MyModel
        fields = 'all'

然后,创建一个基于类的视图:

from rest_framework import generics
from .models import MyModel
from .serializers import MyModelSerializer
class MyModelListView(generics.ListCreateAPIView):
    queryset = MyModel.objects.all()
    serializer_class = MyModelSerializer

最后,在你的urls.py中添加这个视图:

from django.urls import path
from .views import MyModelListView
urlpatterns = [
    # ...
    path('mymodel/', MyModelListView.as_view(), name='mymodel-list'),
]

现在,你已经创建了一个简单的API视图,可以通过/api/mymodel/访问。


五、结语


本篇文章小圈只是做了一个简单的引入以及介绍,DRF有很多其他功能和选项,可以满足更复杂的API需求。比如:更丰富的类视图、身份认证与权限管理等,后续小圈会抽空根据案例为大家带来更精细化的DRF学习教程。现在我们可以通过深入研究DRF文档和示例,更好地利用这个强大的工具。


希望这篇博文能够帮助你开始使用Django Rest Framework,构建出强大且高效的Web API。祝大家编码愉快!

相关文章
|
2月前
|
存储 监控 算法
淘宝买家秀 API开发实录Python(2025)
本文讲述了作者在电商开发领域,尤其是对接淘宝买家秀 API 接口过程中所经历的挑战与收获。从申请接入、签名验证、频率限制到数据处理和实时监控,作者分享了多个实战经验与代码示例,帮助开发者更高效地获取和处理买家秀数据,提升开发效率。
|
5月前
|
API C++ 开发者
PySide vs PyQt:Python GUI开发史诗级对决,谁才是王者?
PySide 和 PyQt 是 Python GUI 开发领域的两大利器,各有特色。PySide 采用 LGPL 协议,更灵活;PyQt 默认 GPL,商业使用需授权。两者背后团队实力雄厚,PySide 得到 Qt 官方支持,PyQt 由 Riverbank Computing 打造。API 设计上,PySide 简洁直观,贴近原生 Qt;PyQt 增加 Pythonic 接口,操作更高效。性能方面,两者表现优异,适合不同需求的项目开发。选择时可根据项目特点与开源要求决定。
407 20
|
28天前
|
设计模式 人工智能 API
AI智能体开发实战:17种核心架构模式详解与Python代码实现
本文系统解析17种智能体架构设计模式,涵盖多智能体协作、思维树、反思优化与工具调用等核心范式,结合LangChain与LangGraph实现代码工作流,并通过真实案例验证效果,助力构建高效AI系统。
291 7
|
2月前
|
算法 程序员 API
电商程序猿开发实录:淘宝商品python(2)
本文分享了开发者在对接淘宝商品详情API过程中的真实经历,涵盖权限申请、签名验证、限流控制、数据解析及消息订阅等关键环节,提供了实用的Python代码示例,帮助开发者高效调用API,提升系统稳定性与数据处理能力。
|
3月前
|
数据采集 存储 数据库
Python爬虫开发:Cookie池与定期清除的代码实现
Python爬虫开发:Cookie池与定期清除的代码实现
|
4月前
|
IDE 开发工具 Python
魔搭notebook在web IDE下,使用jupyter notebook,python扩展包无法更新升级
魔搭notebook在web IDE下,使用jupyter notebook,python扩展包无法更新升级,不升级无法使用,安装python扩展包的时候一直停留在installing
111 4
|
4月前
|
人工智能 搜索推荐 数据可视化
用 Python 制作简单小游戏教程:手把手教你开发猜数字游戏
本教程详细讲解了用Python实现经典猜数字游戏的完整流程,涵盖从基础规则到高级功能的全方位开发。内容包括游戏逻辑设计、输入验证与错误处理、猜测次数统计、难度选择、彩色输出等核心功能,并提供完整代码示例。同时,介绍了开发环境搭建及调试方法,帮助初学者快速上手。最后还提出了图形界面、网络对战、成就系统等扩展方向,鼓励读者自主创新,打造个性化游戏版本。适合Python入门者实践与进阶学习。
442 1
|
4月前
|
Linux 数据库 数据安全/隐私保护
Python web Django快速入门手册全栈版,共2590字,短小精悍
本教程涵盖Django从安装到数据库模型创建的全流程。第一章介绍Windows、Linux及macOS下虚拟环境搭建与Django安装验证;第二章讲解项目创建、迁移与运行;第三章演示应用APP创建及项目汉化;第四章说明超级用户创建与后台登录;第五章深入数据库模型设计,包括类与表的对应关系及模型创建步骤。内容精炼实用,适合快速入门Django全栈开发。
143 1
|
4月前
|
存储 算法 数据可视化
用Python开发猜数字游戏:从零开始的手把手教程
猜数字游戏是编程入门经典项目,涵盖变量、循环、条件判断等核心概念。玩家通过输入猜测电脑生成的随机数,程序给出提示直至猜中。项目从基础实现到功能扩展,逐步提升难度,适合各阶段Python学习者。
228 0
|
4月前
|
数据采集 存储 监控
抖音直播间采集提取工具,直播间匿名截流获客软件,Python开发【仅供学习】
这是一套基于Python开发的抖音直播间数据采集与分析系统,包含观众信息获取、弹幕监控及数据存储等功能。代码采用requests、websockets和sqlite3等...

热门文章

最新文章

推荐镜像

更多