Flask后端接口开发

已于 2023-11-22 09:53:36 修改
阅读量1.8k 收藏 12
点赞数
文章标签： flask 数据库 python JSON数据接口
于 2023-07-05 18:02:46 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/ffei060828/article/details/131409733
版权

创建Flask项目

最简单的Flask项目

  • 创建一个基本的Python项目，带虚拟运行环境
  • 在【File】→【Settings】→【Project：】→【Python Interperter】安装Flask包
  • 在main文件中创建初始化程序，运行测试。
from flask import  Flask

app=Flask(__name__)

@app.route('/index')
def index():
    return "你好Flask"

if __name__ == '__main__':
    app.run(host="0.0.0.0", debug=True, port=8000)

服务运行说明

  • host 指定运行的主机，127.0.0.1表示本机运行，0.0.0.0 表示可以通过网络访问

  • dubug 指定调试模式，错误是否在网页端显示

  • port 运行的服务器端口号

    注意：出现”以一种访问权限不允许的方式做了一个访问套接字的尝试“错误，很有可能是端口号被占用

数据库

数据库的链接

  • 下载安装pymysql

  • 下载安装 Flask-SQLAlchemy

    在Flask程序中一般不直接使用pymysql直接写原生SQL语句去操作数据库，更多的是通过SQLAlchemy提供的ORM技术去操作数据库。Flask-SQLAlchemy是在Flask中操作关系型数据库的拓展，是以面向模型对象的形式操作数据库，避免传统通过SQL语句进行数据库操作的复杂度和安全性。

    from flask import  Flask
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)
# 数据库配置信息
HOSTNAME = "127.0.0.1"
PORT = 3306
USERNAME = "root"
PASSWORD = "123456"
DATABASE = "flask"
app.config['SQLALCHEMY_DATABASE_URI'] = f"mysql+pymysql://{USERNAME}:{PASSWORD}@{HOSTNAME}:{PORT}/{DATABASE}?charset=utf8mb4"

db = SQLAlchemy(app)

创建类模型，通过ORM创建数据表

class User(db.Model):
    __tablename__ = "user"
    id = db.Column(db.Integer, primary_key=True, autoincrement=True)
    username = db.Column(db.String(100), nullable=False)
    password = db.Column(db.String(100), nullable=False)
#自动生成表
with app.app_context():
    db.create_all()
  1. 创建一个User数据模型类
  2. 调用db.create_all()在数据库中建立对应的数据表

创建一对多的链接表

class Article(db.Model):
    __tablename__ = "article"
    id = db.Column(db.Integer, primary_key=True, autoincrement=True)
    title = db.Column(db.String(200), nullable=False)
    content = db.Column(db.String(100), nullable=False)
    # 添加作者外键
    author_id = db.Column(db.Integer, db.ForeignKey("user.id"))
    # 添加关联对象属性，backref 会自动给User模型添加一个articles的属性
    author = db.relationship("User", backref="articles")

  1. 给文章表创建一个外键author_id 对应user表中的id字段

  2. 添加一个author属性，对应文章的一个User，并反向在在User类中创建一个articles的属性，用于返回当前作者的所有的文章

数据库的增删改查

增加记录

  1. 创建要插入的对象并赋值
  2. 通过db.session.add 增加新插入的对象
  3. 通过 db.session.commit() 把回话中的元素进行提交
@app.route('/useradd/')
def userAdd():
    user=User(username = "李子豪", password = "234")
    db.session.add(user)
    db.session.commit()
    result=Result(msg="添加成功！")
    resDict=vars(result)  #对象转化为字典
    print(resDict)

    return jsonify(resDict)

@app.route('/useradd2/')
def userAdd2():
    user=User()
    user.username="郑振华"
    user.password="456"
    db.session.add(user)
    db.session.commit()
    result=Result(msg="添加成功！")
    resDict=vars(result)  #对象转化为字典
    print(resDict)

    return jsonify(resDict)

查找记录

获取所有数据
user=User.query.all()
根据主键查询

采用user=User.query.get(1) ，get 的参数是主键的值

@app.route('/getuser1/')
def getUser1():
    user=User.query.get(31)  #根据主键查找
    if user is None:
        res=Result(code="fail",msg="记录不存在")
        return  jsonify(vars(res))
    else:
        res=Result(msg="查找成功")
        res.data.append(user.toDict())
        return jsonify(vars(res))
获取第一条数据
user=User.query.first()
获取记录的总数
res=User.query.count()
根据条件查询

采用User.query.filter_by(username=“张五”) 通过 filter_by 查询条件的方式进行查询，查询的结果可能有多个值。
注意：filter_by() 只能筛选条件等于，不支持 大于 (>)和小于 (<)和 and_、or_查询

@app.route('/getuser2/')
def getUser2():
    userLst=User.query.filter_by(username="张五")
    res = Result(msg="查找成功")
    for user in userLst :
        res.data.append(user.toDict())
    if len(res.data)<=0 :
        res2=Result(code="fail",msg="记录不存在")
        return jsonify(vars(res2))
    else:
        return jsonify(vars(res))

  • 模型类.query.fillter_by(字段名 =值) 等价于 select * from user where 字段名=值

  • 模型类.query.fillter_by(字段名 =值).first() 等价于 select * from user where 字段名=值 limit 1

  • 模型类.query.fillter(模型类.字段名.like('%z%')).all() 等价于 select * from user where 字段名 like '%z%'

  • 模型类.query.fillter(模型类.字段名.in_(['a','b','c'])).all() 等价于 select * from user where 字段名 in ('a','b','c')

  • 模型类.query.fillter(模型类.字段名.between(开始,结束)).all() 等价于 select * from user where 字段名 between 开始 and 结束

in查询

in_函数的使用
我们使用了in_函数来创建in子句查询条件。在Flask SQLAlchemy中，in_函数用于将列表或子查询包装成一个in子句查询条件。我们可以通过调用模型类的属性和方法以及SQLAlchemy提供的函数来构建复杂的查询条件。下面是一些常用的in_函数的使用示例：

使用模型类的属性：User.query.filter(User.name.in_([‘Alice’, ‘Bob’, ‘Charlie’])).all()
使用子查询：User.query.filter(User.id.in_(db.session.query(Order.user_id).filter(Order.status == ‘completed’))).all()
使用函数：User.query.filter(User.age.in_(db.session.query(func.avg(User.age)).group_by(User.department)))).all()

组合查询
  1. 需要导入 from sqlalchemy import or_, and_, not_
  2. 具体操作
    • 模型类.query.fillter(or_(模型类.字段名.like('z%'),模型类.字段名.contains('a'))).all() 等价于 select * from user where 字段名 like 'z%' or 字段名 like '%a%'
    • 模型类.query.fillter(and_(模型类.字段名.like('z%'),模型类.字段名 < '2021-12-12 00:00:00')).all() 等价于 select * from user where 字段名 like 'z%' and 字段名 < '2021-12-12 00:00:00'
排序
  • 无条件排序 模型类.query.order_by (模型类.字段名.desc()).all() 等价于 select * from user order by 字段名 desc
  • 有条件排序 模型类.query.fillter(模型类.字段名==值).order_by (模型类.字段名.desc()).all() 等价于 select * from user where 字段名=值 order by 字段名 desc
返回前几条记录
更新记录

  1. 查询记录，如果用query.filter_by 查询可以用first()返回查询的第一条记录

    user=User.query.filter_by(username="王五").first()  #返回查询的第一条记录
user.password="88888"
db.session.commit()

  2. 修改记录的对应值

  3. 调用session的commit方法，更新缓存，保存到数据库

删除记录
  1. 查询记录
  2. 从seesion会话中删除
  3. 调用session的commit方法，更新缓存，保存到数据库
@app.route('/userdelete/')
def userDelete():
    user = User.query.filter_by(username="张三").first()  # 返回查询的第一条记录
    db.session.delete(user)
    db.session.commit()
    return "成功"

用户登录获取Token

Token 的作用和原理

  • 首次登录时，后端服务器判断用户账号密码正确之后，根据用户id、用户名、定义好的秘钥、过期时间生成 token ，返回给前端
  • 前端拿到后端返回的 token ,存储在 localStroage
  • 后端接口判断请求头有无 token，没有或者 token 过期，返回401；

设置Token

  1. 安装Authlib 包

  2. 调用以下代码设置token信息

    # 生成token
header = {'alg': 'HS256'}  #签名算法
key = current_app.config['SECRET_KEY'] #用于签名的密钥
data={"id":user.id,"username":user.username}  # token中存放的用户数据
token=jwt.encode(header=header, payload=data, key=key).decode('utf-8') #生成token

获取Token信息

@bp.route("/getApp",methods=["POST"])
def getApp():
    getToken=request.headers.get("token")
    result = Result()
    if getToken is None :
        result.state=401
        result.msg="没有权限"
    else:
        userId=Dbtools.getUserId(getToken)
        user=User.query.get(userId)
        result.data=user.toDict()

    return jsonify(vars(result))

返回JSON数据接口

返回中文乱码问题

通过app.json.ensure_ascii = False 可以实现中文uncode编码问题。

app = Flask(__name__)
app.json.ensure_ascii = False

注意：在Flask 2.3.2版本下 app.config['JSON_AS_ASCII'] = False 解决中文编码方式无效

jsonify

  • Content-Type: application/json 自动为json格式，不用进行设置

  • 基本用法如下，resDict为字典格式

    return jsonify(resDict)

  • 类对象转化为字典，result为一个类对象，resDict是一个字典

    resDict=vars(result)  #对象转化为字典

创建返回结果的默认字典类

#定义一个结果类，用于返回结果
class Result :
    def __init__(self,state = 200, code = "success" ,msg = ""):
        self.state=state
        self.code=code
        self.msg=msg
        self.data=dict() #创建空字典
  • state 状态码，（200:成功,400:失败,401:认证失败，无权限,502:拒绝)
  • code 响应代码(success:成功,error:失败)
  • msg 响应消息
  • data 响应数据

蓝图Blueprint

应用程序配置

  1. 创建config.py文件用于存储app的相关配置

    # 数据库配置信息
HOSTNAME = "127.0.0.1"
PORT = 3306
USERNAME = "root"
PASSWORD = "123456"
DATABASE = "flask"
DB_URI = "mysql+pymysql://{}:{}@{}:{}/{}?charset=utf8mb4".format(USERNAME,PASSWORD,HOSTNAME,PORT,DATABASE)
SQLALCHEMY_DATABASE_URI = DB_URI

  2. 在mian.py 中导入config.py ,并绑定配置文件

    app.config.from_object(config)  # 导入数据库配置信息

创建扩展文件

  1. 创建exts.py

  2. 把相关数据库操作的扩展包，放在该文件下防止重复导入,循环引用

  3. 在main.py中导入

    from Exts import db , Result

  4. 在main.py 中绑定app

    db.init_app(app)

创建数据模型

  1. 创建数据模型文件models.py 用于存放数据模型

创建路由蓝图

  1. 创建python 包，名称可以随意，用于存放路由的蓝图

  2. 创建蓝图相关代码，核心代码bp=Blueprint("user",__name__,url_prefix="/user") url_prefix 用于指定路由的前缀

    from flask import Blueprint
from Exts import db,Result

bp=Blueprint("user",__name__,url_prefix="/user")

@bp.route("/add")
def userAdd():
    pass

  3. 导入并注册蓝图

    from Route.User import bp as user_bp
……
app.register_blueprint(user_bp)   # 注册蓝图

创建蓝图后main.py 中的代码

from flask import Flask
from Exts import db
import config
from Route.User import bp as user_bp
from models import *
from flask_cors import CORS

app = Flask(__name__)
app.json.ensure_ascii = False
CORS(app, resources=r'/*')  #可以跨域访问

app.config.from_object(config)  # 导入数据库配置信息
db.init_app(app)   #取代 db = SQLAlchemy(app)

with app.app_context():
    db.create_all()

app.register_blueprint(user_bp)

if __name__ == '__main__':
    app.run(host="0.0.0.0", debug=False, port=8000)

Flask跨域访问问题

什么是跨域问题

  • 跨域是因为出于浏览器的同源策略限制，它是浏览器最核心也最基本的安全功能，如果缺少了同源策略，则浏览器的正常功能可能都会受到影响。同源策略会阻止一个域的javascript脚本和另外一个域的内容进行交互。
  • 所谓同源（即指在同一个域）就是两个页面具有相同的协议（protocol），主机（host）和端口号（port）。
  • 跨域问题就是当一个请求url的协议、域名、端口三者之间任意一个与当前页面url不同时出现的问题。

问题描述

当客户端向服务器端请求ajax服务时，如果客户端和服务器端域名不一致，就会出现跨域问题，ajax报错如下：

No 'Access-Control-Allow-Origin' header is present on the requested

解决方式

  1. 安装flask_cors

  2. app初始化的时候就加载配置

    from flask import Flask
from flask_cors import CORS
app = Flask(__name__)
# r'/*' 是通配符，让本服务器所有的 URL 都允许跨域请求
CORS(app, resources=r'/*')
if __name__ == "__main__":
	app.run()
无忧无虑Coding
关注
  • 0
    点赞
  • 踩
  • 12
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
python后端接口怎么写_用Flask写后端接口
weixin_29012765的博客
01-29 2723
此篇为全栈技能系列的第13篇。往期直达：为什么选择Flask，因为接下来要更新深度学习的相关技能了，用到的是python，为了给前端提供api，选择了python的Flask来开发web应用的后端服务，Nodejs不够用了哈。01安装Flask确保已经安装过python，可以用终端输入：python --version查看python安装与否及其版本，接下来在终端中输入：pip install f...
flask前后端
m0_60360382的博客
09-08 357
使用flask缩写的前后端代码
爬虫（2）-Flask后端 -接口
帅气dc的博客
12-29 1216
通过flask显示页面
Flask：后端框架使用
最新发布
Daisy的博客
08-06 1062
Flask是由python语言编写的轻量级Web应用框架，主要应用于后端框架，处理客户端请求并返回响应。
Flask后端实践 连载三 接口标准化及全球化
那些年踩过的坑丶
03-23 4821
设计实现FlaskRestful标准化接口项目场景接口统一返回形式响应状态码响应消息返回消息 tips: 本文主要解决项目中历史遗留问题，将产品正规化，统一接口返回。 本文基于python3编写 项目场景 某日，本人终于受不了前人挖坑，大怒！！！V1版本项目restful接口返回一团糟，没有固定的格式，前端大佬也是抱怨多次。在本人的积极怂恿下，项目经理决定重写项目，解决诸多历史遗留问题（多...
使用Flask编写一个最简单的后端接口
叶卡捷琳堡的博客
09-06 598
Flask是一个轻量级的Python Web框架，它使用Python语言编写，并且使用MVC模式进行开发。Flask被称为微框架，但这并不意味着它只能处理小型应用程序，而是指它的代码结构简单、易于扩展。Flask架构适合小型和中型的应用程序开发，它提供了构建Web应用程序所需的基本功能，包括路由、模板渲染、请求和响应处理等。使用Flask可以让开发者轻松地创建自定义的Web应用程序，并且可以根据需要添加其他扩展来增强功能。Flask架构适合个人项目或小团队开发的项目，它易于上手并且具有灵活性和可扩展性。
Flask接口开发教程
yidaogggg的博客
01-08 5762
Flask接口开发教程 Flask是一个使用 Python 编写的轻量级 Web 应用框架，很适合个人开发，我们在此处做一个接口。 准备 我们搭建好python环境后使用pip install flask（或者有环境管理工具anaconda等工具的在对应环境导 入）安装第三方库flask。我们使用的时flask模块中的Flask方法，若我么能使用pycharm创建flask项目也 会生成app.py文件，如下： from flask import Flask app = Flask(__name
Python Flask开发一个简单的接口
qq_41952323的博客
12-14 559
首先看项目结构： 查看红色区域目录结构及内容。 1、在python11目录下创建test_api，test_api新建login_api 2、打开login_api输入一下代码（可参考代码注释）： from flask import Flask,request import json app = Flask(__name__) @app.route("/test_1.0",methods=["POST"]) def login(): # 默认返回内容 return_request =
Python+Flask 接口开发
u010044902的博客
05-17 179
#!/usr/bin/env python -- coding:utf-8 -- import flask, json, logging import ConenctDB #引用ConnectMysql文件 from flask import request logging.basicConfig(level=logging.INFO, format=’%(asctime)s - %(name)s...
flask后端开发接口示例，利用Flask开发后端API接口。.zip
09-28
flask后端开发接口示例，利用Flask开发后端API接口。包含基本的项目配置、统一响应、MySQL和Redis数据库操作、定时任务、图片生成、项目部署、用户权限认证、报表输出、无限层级生成目录树、阿里云手机验证码验证、...
YOLOV7 苹果叶部病害识别 flask 后端.zip
05-15
YOLOV7 苹果叶部病害识别与Flask后端系统是计算机视觉和Web开发领域的结合，用于自动化农业病害检测。这个项目利用了先进的深度学习模型YOLOv7，该模型专为实时目标检测设计，尤其适用于苹果树叶病害的识别。Flask是...
毕设系统 flask后端.zip
12-27
《毕设系统 Flask后端开发详解》 在IT领域，毕业设计是学生们展现技术实力、理论与实践结合的重要环节。本篇文章将详细探讨基于Flask框架的毕设系统后端开发，帮助读者深入理解Web应用的构建过程。Flask作为Python...
基于YOLOV7的苹果叶部病害识别 flask 后端.zip
05-15
标签“源码”表明这个压缩包包含的是实现上述功能的源代码，可能包括YOLOv7模型的训练脚本、Flask后端的服务代码、数据处理脚本等。文件列表中的"code"可能是一个目录，包含了所有相关的Python脚本和其他支持文件。 ...
python：接口开发
python学习者的博客
05-21 2219
一、flask flask是一个python编写的轻量级框架，可以使用它实现一个网站或者web服务。本文就用flask来开发一个接口。 flask需要先安装再引用。pip install flask 用flask开发接口的流程为： 1、定义一个server server=flask.Flask(__name__) #__name__代表当前的python文件。把当前的python文件当做...
flask前后端项目--实例-后端部分：-2-api接口的实现
wtt234的专栏
12-01 985
前后端分离项目中，重要的是后端可以给前端提供api接口。我们这里采用restfulapi风格的提供api接口。1.post-添加数据post方式（json数据）3.delete（delete修改数据）2.get展示数据（全部数据-all）5.再次查询确认，完成查询操作。再次查询，确认数据删除成功！对上述的连接进行测试。
使用Flask开发简单接口
weixin_39827856的博客
04-25 7506
使用Flask开发简单接口 作为测试人员，在工作或者学习的过程中，有时会遇到没有可以调用的现成的接口，导致我们的代码没法调试跑通的情况。 这时，我们使用python中的web框架Flask就可以很方便的编写简单的接口，用于调用或调试。在之前的pytest系列文章中，已经使用过Flask编写接口用于代码调试。相比于python的另一个web框架Django，Flask编写接口要方便简单很多。 那么，接下来就告诉大家如何使用Flask编写简单的接口吧。 安装Flask 安装命令：pip install
python flask接口开发_Python--flask模块，开发接口
weixin_39692254的博客
12-03 226
import flask # web框架from day06.tools import op_mysqlimport json# 接口，后台服务server = flask.Flask(__name__) # 把咱们这个python文件当做一个server# 127.0.0.1:8080/get_user@server.route('/get_user', methods=['get', 'p...
借助flask快速实现json格式返回的后端接口
LiXueFu727224204的博客
01-29 369
切换到工程目录，如 cd D:\D\python_work\spider\testcase 创建虚拟环境flask D:\D\python_work\spider\testcase\virtualenv flask 进入创建的那个flask目录 cd D:\D\python_work\spider\testcase\flask 激活虚拟环境 # 旧版的命令激活为 source bin/activate D:\D\python_work\spider\testcase\flask\cd .
【后端开发】flask响应体接口标准化
liuty的博客
07-03 578
基本设想： { "code":200, "msg":"成功", "data":null } 其中code代表响应状态码，msg传递结果信息或异常信息，data用于返回响应数据。 # -*- coding: utf-8 -*-# # Name: response_body # Description: # Author: lty # Date: 2020/6/24 from flask import jsonify # 响应代码类： class R.
微信小程序后端接口用flask怎么写
06-06
首先，你需要安装 Flask 和其它需要的依赖库。可以通过以下命令安装： ``` pip install flask ``` 接下来，你需要创建一个 Python 文件，比如叫做 `app.py`，然后在文件中导入 Flask 和其它需要的库： ``` from flask import Flask, request, jsonify ``` 接着，你需要创建一个 Flask 应用程序实例： ``` app = Flask(__name__) ``` 在 Flask 应用程序实例中，你可以定义路由和相应的视图函数，来处理客户端发送的请求。 比如，你可以定义一个 `/login` 路由，用于处理客户端发送的登录请求： ``` @app.route('/login', methods=['POST']) def login(): # 获取客户端发送的请求数据 data = request.json # 处理登录逻辑 # ... # 返回响应数据 return jsonify({'result': 'success'}) ``` 在视图函数中，你可以通过 request 对象获取客户端发送的请求数据，然后根据请求数据处理相应的业务逻辑。 最后，你需要运行 Flask 应用程序： ``` if __name__ == '__main__': app.run(debug=True) ``` 其中，`debug=True` 表示开启调试模式，可以在开发过程中方便地查看应用程序的调试信息。 以上是一个简单的 Flask 后端接口实现示例。具体实现还需根据你的具体业务需求来定制。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值