FlaskAPI-初识

1 简介

Flask API 是 Flask 的直接替代品,它提供类似于 Django REST 框架提供的可浏览 API的实现。它为你提供适当的内容协商响应和智能请求解析。这是官网的解释,那我们用Flask框架来介绍Flask API。

Flask是一个基于 WSGI(Web Server Gateway Interface)的 Web 框架。WSGI 是一种规范,它定义了 Web 服务器和 Python Web 应用程序之间的接口。Flask 本身遵循这个规范,使得它可以和各种支持 WSGI 的服务器(如 Gunicorn)一起工作。然而,WSGI 有一些局限性。它是同步的,在处理高并发场景(如大量的同时请求)时效率相对较低。例如,当一个请求在等待数据库查询结果或者进行一些耗时的 I/O 操作时,整个线程会被阻塞,其他请求就需要等待。

ASGI(Asynchronous Server Gateway Interface)是 WSGI 的异步版本。它允许应用程序以异步的方式处理请求,能够更好地利用系统资源,提高应用程序的性能和并发处理能力。在现代的 Web 开发中,尤其是在处理大量实时通信(如 WebSockets)或者高并发的 API 场景下,ASGI 的优势就凸显出来了。比如在一个实时聊天应用中,多个用户同时发送消息,ASGI 服务器可以更高效地处理这些并发的 WebSocket 连接。

Uvicorn是ASGI服务器的实现,它基于 uvloop 和 httptools 构建。uvloop 是一个用 Cython 编写的高性能 Python 异步 I/O 循环库,它比标准的 asyncio 事件循环要快很多。Uvicorn 在性能方面表现出色,能够快速地处理请求。例如,在处理大量的 API 请求时,它可以利用异步 I/O,减少请求的等待时间,提高吞吐量。它还支持 HTTP/1.1 和 HTTP/2 协议,能够更好地适应现代网络环境。

2 第一个程序

python 复制代码
from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def read_root():
    return {"Hello": "World"}

3 启动方式

3.1 命令行启动

复制代码
uvicorn flask_demo.main:app --reload 
  • uvicorn是启动服务器的命令。

  • main:app是一个参数,它指定了应用的位置。其中main是 Python 模块的名称(通常是一个.py文件,在这里是main.py,但在命令中不需要写.py后缀),app是在main模块中定义的 ASGI 应用对象(例如在 FastAPI 应用中,app = FastAPI()这一行定义的app对象)。

  • --reload是一个可选的参数。它的作用是开启自动重载功能,当然还有其他可选参数例如port、host等。

这是目录的结构:

复制代码
my_project/
    ├── fask_demo/
    │   └── main.py
    └── other_files/

uvicorn 启动命令中:前的代表包含ASGI实例对象文件的位置,层级用.隔开

3. 2 uvicorn.run方法

python 复制代码
app = FastAPI()

@app.get("/")
def read_root():
    return {"Hello": "World"}

if __name__ == '__main__':
    uvicorn.run(app)

当然我们还可以设置一些参数,下面是一些常用参数:

参数 描述 默认值 示例值
app 要运行的ASGI应用对象,通常是在模块中定义的如FastAPI或Starlette应用实例。 app(假设app是在当前模块中定义的应用对象)
host 服务器监听的主机地址。 127.0.0.1 0.0.0.0(可以从外部访问)
port 服务器监听的端口号。 8000 8080
reload 是否开启自动重载功能。当代码文件发生变化时自动重新加载应用。 False True(用于开发环境)
workers 工作进程数,用于处理多个并发请求。在生产环境中可以通过增加工作进程来提高性能。 1 4(根据服务器资源和负载情况设置)
loop 指定事件循环类型。如uvloop可以提高性能(如果已安装)。 auto(自动选择合适的循环) uvloop(如果安装了uvloop
http 指定HTTP协议实现。如h11httptools auto(自动选择合适的实现) httptools(如果安装了httptools
ws 指定WebSocket协议实现。 auto(自动选择合适的实现) websockets(如果安装了websockets
lifespan ASGI应用生命周期管理。用于处理应用启动和关闭时的事件。 auto(自动遵循应用定义) on(手动开启生命周期管理)
interface 指定服务器接口类型,如asgi3asgi2。用于兼容不同版本的ASGI规范。 asgi3 asgi2(如果应用遵循ASGI 2规范)
env_file 指定环境变量文件路径。文件中的环境变量会被加载用于配置应用。 ".env"(当前目录下的.env文件)
相关推荐
巴里巴气1 小时前
selenium基础知识 和 模拟登录selenium版本
爬虫·python·selenium·爬虫模拟登录
19891 小时前
【零基础学AI】第26讲:循环神经网络(RNN)与LSTM - 文本生成
人工智能·python·rnn·神经网络·机器学习·tensorflow·lstm
JavaEdge在掘金1 小时前
Redis 数据倾斜?别慌!从成因到解决方案,一文帮你搞定
python
ansurfen1 小时前
我的第一个AI项目:从零搭建RAG知识库的踩坑之旅
python·llm
前端付豪1 小时前
20、用 Python + API 打造终端天气预报工具(支持城市查询、天气图标、美化输出🧊
后端·python
前端付豪1 小时前
19、用 Python + OpenAI 构建一个命令行 AI 问答助手
后端·python
amazinging2 小时前
北京-4年功能测试2年空窗-报培训班学测开-第四十三天
python·学习
wgyang20162 小时前
我的第一个LangFlow工作流——复读机
python
Zhen (Evan) Wang3 小时前
(豆包)xgb.XGBRegressor 如何进行参数调优
开发语言·python
我爱一条柴ya3 小时前
【AI大模型】线性回归:经典算法的深度解析与实战指南
人工智能·python·算法·ai·ai编程