Python Flask RESTful使用demo演示
作者:大数据老司机 发布时间:2023-08-04 07:02:23
一、RESTful 概述
REST(Representational State Transfer)风格是一种面向资源的 Web 应用程序设计风格,它遵循一些设计原则,使得 Web 应用程序具有良好的可读性、可扩展性和可维护性。下面我们来详细解释一下 RESTful 风格的各个方面:
资源标识符:在 RESTful 风格中,每个资源都有一个唯一的标识符,通常是一个
URL(Uniform Resource Locator)
。URL 用于标识资源的位置,使得客户端可以使用 HTTP 协议进行访问。例如,一个简单的 URL 可以是:http://example.com/products/123
,其中“products”
表示资源类型,“123”
表示资源标识符。表示层:资源可以以不同的格式表示,例如
JSON
,XML
,HTML
等。客户端可以根据需要选择适当的表示形式进行交互。例如,一个RESTful API
可以返回JSON
格式的数据,以便客户端可以更容易地解析和处理数据。自描述消息:每个消息都应该包含足够的信息,以描述如何处理该消息。例如,HTTP 响应应该包含状态码、响应头和响应正文等信息,以便客户端可以理解响应的含义。
无状态通信:
RESTful
风格的设计强调无状态通信,这意味着每个请求都应该包含所有必要的信息以处理该请求,而不依赖于先前的请求。这可以使得 Web 应用程序更加简单和可扩展,因为服务器不需要保留任何状态信息。统一接口:所有资源应该通过相同的接口来访问。这意味着客户端可以使用相同的 HTTP 方法(如
GET
、POST
、PUT
、DELETE
等)来操作不同类型的资源。这使得 API 更加简单和一致,并且更容易被其他开发者理解和使用。
总之,RESTful 风格的设计使得 Web 应用程序更加灵活、可扩展和易于维护,是一种现代化的 Web 应用程序设计方式。
RESTful 官网:restfulapi.net/
二、Python 中的 RESTful
Python 可以用于实现 RESTful 风格的 Web 应用程序,通常使用一些 Web 框架来简化开发过程。下面是一些常见的 Python Web 框架:
Flask
:Flask
是一个简单、轻量级的 Web 框架,可以用来构建 RESTful 风格的 Web 应用程序。它使用 Python 的装饰器语法来定义 HTTP 路由,使得编写 Web 应用程序变得简单和直观。Flask 还提供了扩展机制,使得开发人员可以轻松地添加新的功能,例如数据库访问、表单验证等。Django
:Django
是一个功能强大、全面的 Web 框架,可以用于构建复杂的 Web 应用程序。它提供了许多内置功能,例如ORM
(对象关系映射)、表单验证、身份验证等,可以使开发人员更快地构建 Web 应用程序。Django 也支持RESTful
风格的 Web 应用程序开发,可以使用第三方库Django REST framework
来实现。Bottle
:Bottle
是一个轻量级的 Web 框架,它使用 Python 的装饰器语法来定义 HTTP 路由,可以快速构建 RESTful 风格的 Web 应用程序。Bottle 还包含了一些有用的功能,例如模板引擎、数据库访问、静态文件处理等。Pyramid
:Pyramid
是一个灵活、高度可定制的 Web 框架,可以用于构建各种类型的 Web 应用程序,包括 RESTful 风格的 Web 应用程序。Pyramid 提供了许多扩展机制,使得开发人员可以轻松地添加新的功能,例如数据库访问、表单验证、身份验证等。
以上框架都支持 RESTful 风格的 Web 应用程序开发,并且都具有各自的优缺点,开发人员可以根据自己的需求选择合适的框架。
三、Flask RESTful API 示例讲解
1)Flask-RESTful 库讲解
Flask-RESTful 是一个基于 Flask 的扩展库,它提供了一些方便的工具来构建 RESTful API。下面是 Flask-RESTful 的一些主要特点和功能:
资源类:Flask-RESTful 提供了一个 Resource 基类,可以用来创建资源。Resource 类包含了 HTTP 方法(
GET
、POST
、PUT
、DELETE
等)的处理逻辑,并提供了一些方便的方法来处理请求和响应。请求参数解析:Flask-RESTful 提供了一个
RequestParser
类,用于解析请求参数。RequestParser
可以自动将查询参数、表单参数、JSON 参数等解析成 Python 类型,并提供了一些选项来指定参数的类型、默认值、必须存在等限制条件。响应格式化:Flask-RESTful 提供了一个
marshal_with()
装饰器,用于格式化响应数据。marshal_with()
装饰器可以将 Python 对象转换成指定的输出格式(如 JSON、XML 等),并支持指定输出字段、字段类型、嵌套字段等功能。路由定义: Flask-RESTful 提供了一个
Api
类,用于定义路由和资源的映射关系。Api 类包含了add_resource()
方法,用于将资源类和 URL 路由绑定起来。异常处理:Flask-RESTful 提供了一些异常类,用于处理 HTTP 请求和响应中的错误。Flask-RESTful 的异常类包括
abort
、HTTPException
等,可以方便地处理 HTTP 状态码、错误信息等。
综上所述,Flask-RESTful 提供了一些方便的工具来简化 RESTful API 的开发。使用 Flask-RESTful 可以快速地定义资源、解析请求参数、格式化响应数据、定义路由和处理异常等,从而提高开发效率并降低出错的风险。
2)Flask-RESTful 库安装
要安装 Flask-RESTful 库,可以使用 pip 命令进行安装。在终端中执行以下命令:
pip3 install flask-restful
这将会从 PyPI 上下载 Flask-RESTful 库,并安装到本地的 Python 环境中。安装完成后,就可以在代码中导入 flask_restful
模块,使用 Flask-RESTful 提供的功能来构建 RESTful API。
3)RESTful 示例讲解
下面是一个简单的 Flask RESTful API 示例,它实现了一个简单的 To-Do List 应用程序:
from flask import Flask, request
from flask_restful import Api, Resource, reqparse, fields, marshal_with
app = Flask(__name__)
api = Api(app)
todos = {}
todo_fields = {
'id': fields.Integer,
'task': fields.String,
'status': fields.Boolean
}
class TodoList(Resource):
@marshal_with(todo_fields)
def get(self):
return todos
@marshal_with(todo_fields)
def post(self):
parser = reqparse.RequestParser()
parser.add_argument('task', type=str, help='Task is required', required=True)
args = parser.parse_args()
todo_id = len(todos) + 1
todo = {'task': args['task'], 'status': False}
todos[todo_id] = todo
return todo, 201
class TodoItem(Resource):
@marshal_with(todo_fields)
def get(self, todo_id):
return todos[todo_id]
def put(self, todo_id):
parser = reqparse.RequestParser()
parser.add_argument('task', type=str)
parser.add_argument('status', type=bool)
args = parser.parse_args()
todo = todos[todo_id]
if args['task']:
todo['task'] = args['task']
if args['status']:
todo['status'] = args['status']
return todo
def delete(self, todo_id):
del todos[todo_id]
return '', 204
api.add_resource(TodoList, '/todos')
api.add_resource(TodoItem, '/todos/<int:todo_id>')
if __name__ == '__main__':
app.run(debug=True)
启动
# 配置环境变量
export FLASK_APP=restful-test.py
# 启动服务,公开访问需要加上--host=0.0.0.0
python -m flask run --host=0.0.0.0
该示例使用 Flask 和 Flask-RESTful 库来实现 To-Do List 应用程序的 RESTful API。下面是一些重要的代码片段的解释:
定义资源:在示例中,有两个资源:
TodoList
和TodoItem
。TodoList
用于处理所有的 To-Do 任务列表,TodoItem
用于处理单个任务。定义请求参数:在示例中,我们使用 Flask-RESTful 库的 RequestParser 来解析请求参数。我们定义了
'task'
和'status'
参数,并使用add_argument()
方法来指定它们的类型和其他限制条件。定义响应格式:在示例中,我们使用 Flask-RESTful 库的
marshal_with()
装饰器来定义响应的格式。我们定义了一个名为todo_fields
的字典,其中包含了 To-Do 任务的id
、task
和status
字段。定义请求方法:在示例中,我们使用 Flask-RESTful 库的 Resource 类来定义请求方法。我们实现了
GET
、POST
、PUT
和DELETE
方法,用于获取任务列表、添加任务、更新任务和删除任务。添加路由:在示例中,我们使用 Flask-RESTful 库的 Api 类来添加路由。我们使用
add_resource()
方法来将 TodoList 和 TodoItem 类与相应的 URL 路由绑定起来。
在运行该示例后,可以通过访问 URL 来使用 To-Do List 应用程序的 RESTful API。例如,要获取所有任务列表,可以使用以下 URL:
# GET http://localhost:5000/todos
curl http://localhost:5000/todos
要添加一个新任务,可以使用以下 URL:
# POST http://localhost:5000/todos
curl -XPOST http://localhost:5000/todos -d 'task=123'
curl -XPOST http://localhost:5000/todos -d '{"task":"456"}' --header "Content-Type: application/json"
要获取单个任务,可以使用以下 URL:
# GET http://localhost:5000/todos/1
curl http://localhost:5000/todos/1
要更新任务,可以使用以下 URL:
# PUT http://localhost:5000/todos/1
curl -XPUT http://localhost:5000/todos/1 -d '{"task":"test"}' --header "Content-Type: application/json"
# 查看
curl http://localhost:5000/todos/1
要删除任务,可以使用以下 URL:
# DELETE http://localhost:5000/todos/1
curl -XDELETE http://localhost:5000/todos/1
总的来说,这个示例演示了如何使用 Flask-RESTful 来构建简单的 RESTful API,其中包括资源定义、请求参数解析、响应格式定义、请求方法实现和路由添加等关键步骤。
来源:https://juejin.cn/post/7206540113572331576
猜你喜欢
- 写在之前围绕类的话题,说是说不完的,仅在特殊方法,除了我们在前面遇到过的 __init__(),__new__(),__str__() 等之
- 简述Matplotlib是一个基于python的2D画图库,能够用python脚本方便的画出折线图,直方图,功率谱图,散点图等常用图表,而且
- 注:本文是应Alan邀请为《CSS布局实录》写的一个web标准入门指导。书已经上市近一年了,现在摘选出来,给初学者一个参考。希望了解更多实现
- 本文实例为大家分享了Android九宫格图片展示的具体代码,供大家参考,具体内容如下<!DOCTYPE html><htm
- Socket的基本背景在讨论这两个选项的区别时,我们需要知道的是BSD实现是所有socket实现的起源。基本上其他所有的系统某种程度上都参考
- 安装了个5.5版本的mysql,字符集出现了问题,之前的mysql服务器都是通过在my.cnf配置文件中进行配置便可,可是今儿怎么着都不行一
- 1. 概述Python中 asyncio 模块内置了对异步IO的支持,用于处理异步IO;是Python 3.4版本引入的标准库。asynci
- 在使用AJAX获取数据时后台返回的大部分都是json数据,在进行程序开发时有时会需要直接对这些json数据在js程序中再进行一定的操作,如排
- 这篇文章主要讲TensorFlow中的Session的用法以及Variable。Session会话控制Session是TensorFlow为
- 就在刚才,我给GMAIL安装了Twitter插件。安装完插件后,Gmail提示我要连接Twitter的账号才能使用:我顺着提示操作下去,就看
- 本文实例讲述了基于Python开发chrome插件的方法。分享给大家供大家参考,具体如下:谷歌Chrome插件是使用HTML、JavaScr
- 学习了Go语言后,打算利用最近比较空一点,写一个前端部署工具,不需要每次都复制粘贴的麻烦,需要完成部署的第一步就需要连接远程服务器打开 ss
- 1,安装 安装就不多说了,除了一般的那个压缩包
- finetune分为全局finetune和局部finetune。首先介绍一下局部finetune步骤:1.固定参数 for na
- 当用户关闭cookie时,通过asp程序提示访客打开,源代码如下: Dim strCookie, strT
- 首先先发一下我的项目路径1. 首先要下载 sass-resources-loadernpm install sass
- mysql复制表中的一列到另一个表中有时候,我们需要复制某个字段一整列的数据到另外一个新的字段中,这很简单,SQL可以这么写:UPDATE
- 离散特征的编码分为两种情况: 1、离散特征的取值之间没有大小的意义,比如color:[red,blue],那么就使用one-hot编码2、离
- 首先先了解一下,我们的效果实现流程首先登录概述及业务流程和相关技术点录页面的布局创建两个Vue.js文件一个我们来做登录页和注册页登录页面的
- 继续分享pygame有趣的技术知识,欢迎往下看。一、先搭个架子(一)黏贴背景图:实现代码如下:import pygamepygame.ini