Python框架篇(1):FastApi-快速入门

news2024/11/23 11:26:41

1.介绍

前言: 不管学什么语言，都应该至少掌握一个框架，方面我们后续，进行服务部署、服务对外支持等;

1.1 官网介绍

下面是来自FastAPI官网的介绍:

FastAPI 是一个用于构建 API 的现代、快速（高性能）的 web 框架，使用 Python 3.8+ 并基于标准的 Python 类型提示。

关键特性:

  • 快速：可与 NodeJS 和 Go 并肩的极高性能（归功于 Starlette 和 Pydantic）。最快的 Python web 框架之一。

  • 高效编码：提高功能开发速度约 200％ 至 300％。

  • 更少 bug：减少约 40％ 的人为（开发者）导致错误。

  • 智能：极佳的编辑器支持。处处皆可自动补全，减少调试时间。

  • 简单：设计的易于使用和学习，阅读文档的时间更短。

  • 简短：使代码重复最小化。通过不同的参数声明实现丰富功能。bug 更少。

  • 健壮：生产可用级别的代码。还有自动生成的交互式文档。

  • 标准化：基于（并完全兼容）API 的相关开放标准：OpenAPI (以前被称为 Swagger) 和 JSON Schema。

  • 官方文档:https://fastapi.tiangolo.com/zh/

1.2 Github热度

框架Star开源地址
django73.9khttps://github.com/django/django
flask64.9Khttps://github.com/pallets/flask
fastapi64.3Khttps://github.com/tiangolo/fastapi

关于选框架一事,每个人的见解都不一样,这里不做比较,简单陈述下,我之所以选择这个框架的原因:

  • 号称和 Go并肩的极高性能, 想体验下;
  • 框架和之前两个对比,相对比较年轻,从 Github star数来看，成长热度挺好；
  • 官方文档中文支持较好,看着也比较完善；

2.依赖安装

@注意: fastapi有版本要求，需要的Python版本至少是Python 3.8

2.1 安装fastapi

# 使用pip安装
$ pip install fastapi

2.2 安装ASGI 服务器

ASGI是异步网关协议接口，一个介于网络协议服务和 Python 应用之间的标准接口，能够处理多种通用的协议类型，包括 HTTP，HTTP2 和 WebSocket。

pip install "uvicorn[standard]"

这里简单了解下什么是uvicorn :

Uvicorn是一个基于ASGI（Asynchronous Server Gateway Interface）的异步Web服务器，用于运行异步Python web应用程序。它是由编写FastAPI框架的开发者设计的，旨在提供高性能和低延迟的Web服务;

3. 快速启动

3.1 编写代码

main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def index():
    """
    注册一个根路径
    :return:
    """
    return {"message": "Hello World"}


@app.get("/info")
async def info():
    """
    项目信息
    :return:
    """
    return {
        "app_name": "FastAPI框架学习",
        "app_version": "v0.0.1"
    }

3.2 启动服务

➜ uvicorn main:app --reload
INFO:     Will watch for changes in these directories: ['/Users/liuqh/ProjectItem/PythonItem/fast-use-ai']
INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO:     Started reloader process [11629] using WatchFiles
INFO:     Started server process [11631]
INFO:     Waiting for application startup.
INFO:     Application startup complete.

启动命令uvicorn main:app --reload中的app，指的是app = FastAPI()变量，也可以是其他自己定义的名称;

1.启动步骤分析:

  • 第一步: 导入 FastAPI( from fastapi import FastAPI),可以把 FastAPI理解为是 API 提供所有功能的 Python 类;
  • 第二步: 创建 FastAPI 实例( app = FastAPI()),实例化一个类,变量 app 是 FastAPI 的 类实例；
  • 第三步: 使用 @app.get注册路由,其中 app是 FastAPI 类实例变量名，也可以是其他；除了 @app.get之外还支持: @app.post、@app.put、@app.delete..等方法；
  • 第四步: 使用 uvicorn启动服务；

3.3 调试模式

虽然通过uvicorn启动服务很方便，但有时候我们需要debug本地程序，方便问题排查,FastAPI也支持传统启动方式;修改main.py文件，追加以下代码:

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

以Debug模式启动后，就可以打断点进行代码调试,具体使用方法可参考官方文档:https://fastapi.tiangolo.com/zh/tutorial/debugging

4.访问服务

4.1 访问接口

alt

4.2 访问文档

FastApi框架在启动时，除了注册路由之外，还会自动生成API在线文档,并且生成两种在线文档: Swagger UI 和 ReDoc，访问地址分别为:

  • SwaggerUi风格文档: http://127.0.0.1:8000/docs
  • ReDoc风格文档： http://127.0.0.1:8000/redoc
alt

1.如何关闭文档生成?

如果不想生成交互式文档,可以通过以下方式实例化FastAPI:

# docs_url=None: 代表关闭SwaggerUi
# redoc_url=None: 代表关闭redoc文档
app = FastAPI(docs_url=None, redoc_url=None)

4.3 访问OpenAPI

FastAPI框架内部实现了OpenAPI 规范，通过访问 http://127.0.0.1:8000/openapi.json,我们可以看到整个项目的 API对应的JSON描述信息,如下:

{
    "openapi": "3.1.0",
    "info": {
        "title": "FastAPI",
        "version": "0.1.0"
    },
    "paths": {
        "/": {
            "get": {
                "summary": "Index",
                "description": "注册一个根路径\n:return:",
                "operationId": "index__get",
                "responses": {
                    "200": {
                        "description": "Successful Response",
                        "content": {
                            "application/json": {
                                "schema": {}
                            }
                        }
                    }
                }
            }
        },
        "/info": {
            "get": {
                "summary": "Info",
                "description": "项目信息\n:return:",
                "operationId": "info_info_get",
                "responses": {
                    "200": {
                        "description": "Successful Response",
                        "content": {
                            "application/json": {
                                "schema": {}
                            }
                        }
                    }
                }
            }
        }
    }
}

5.目录结构

5.1 官方示例目录结构

通常我们开发一个Python服务，都不会将所有代码放到一个文件里，就像我们不会把衣服、鞋子、袜子、食物这些统统装到一个麻袋里一样; 而是会根据功能或者其他规则，分类存放，FastAPI为我们提供了一个模板，具体如下:

.
├── app                  # 「app」是一个 Python 包
│   ├── __init__.py      # 这个文件使「app」成为一个 Python 包
│   ├── main.py          # 「main」模块，例如 import app.main
│   ├── dependencies.py  # 「dependencies」模块，例如 import app.dependencies
│   └── routers          # 「routers」是一个「Python 子包」
│   │   ├── __init__.py  # 使「routers」成为一个「Python 子包」
│   │   ├── items.py     # 「items」子模块，例如 import app.routers.items
│   │   └── users.py     # 「users」子模块，例如 import app.routers.users
│   └── internal         # 「internal」是一个「Python 子包」
│       ├── __init__.py  # 使「internal」成为一个「Python 子包」
│       └── admin.py     # 「admin」子模块，例如 import app.internal.admin

具体代码组织可以参考 更大的应用 - 多个文件: https://fastapi.tiangolo.com/zh/tutorial/bigger-applications/

5.2 自定义目录结构

个人感觉官方推荐的目录结构过于简单，和工作中经常使用的其他语言框架目录结构出入过大，所以进行了自定义修改，也是为了适应自己的开发习惯，具体修改后目录如下:

├── README.md  #项目介绍
├── app
│   ├── __init__.py
│   ├── config  # 配置相关
│   │   └── __init__.py
│   ├── constant  # 常量相关
│   │   └── __init__.py
│   ├── dao # 封装查询数据的方法
│   │   └── __init__.py
│   ├── dependencies  # 封装被依赖函数
│   │   └── __init__.py
│   ├── middleware # 中间件
│   │   └── __init__.py
│   ├── models # 数据模型文件，和表结构对应
│   │   └── __init__.py
│   ├── router # 路由也可以理解controller
│   │   ├── __init__.py
│   │   ├── default_router.py # 默认接口
│   │   └── demo_router.py # 演示接口
│   ├── parameter # 声明参数对应的Pydantic模型
│   │   └── __init__.py
│   ├── service # 就具体业务实现逻辑
│   │   └── __init__.py
│   └── utils # 工具类
│       ├── __init__.py
│       └── str_util.py
├── main.py # 主文件
├── requirements.txt #依赖文件
├── tests # 单元测试目录
    ├── __init__.py
    └── local_test.py

a.__init__.py文件的作用:

  • 标识包目录： 当Python解释器遇到一个目录中包含 __init__.py 文件时，它会将该目录识别为一个包。这样可以通过导入包的方式来组织和访问模块。 在Python3中，__init__.py 不再是创建包的唯一方式

  • 初始化包： __init__.py 文件在包被导入时会被执行，可以用于初始化包级别的变量、设置环境或执行其他必要的初始化操作。

  • 命名空间包含： 通过在 __init__.py 中定义变量、函数或类，可以将它们添加到包的命名空间中，使得在导入包时可以直接访问这些元素。

  • 避免名称冲突： 如果包目录中有与包同名的模块，导入包时可能会出现冲突。__init__.py 可以通过定义__all__变量来控制导入时的名称空间。

    # __init__.py
    __all__ = ['module1', 'module2']

    这样导入包时，只有在 __all__ 中列出的模块会被导入，避免了潜在的名称冲突

6. 路由加载

6.1 路由文件

假如我们在app/router目录下有以下几个文件:

➜  tree -L 2 app/router  -I "__pycache__"
app/router
├── __init__.py
├── default_router.py
└── demo_router.py

每个路由文件里面的编辑流程和逻辑基本一样，这里以default_router.py为例，代码如下:

# 导入APIRouter
from fastapi import APIRouter
# 实例化APIRouter实例
router = APIRouter(tags=["默认路由"])
# 注册具体方法
@router.get("/")
async def index():
    """
    默认访问链接
    """
    return {
        "code": 200,
        "msg": "Hello World!"
    }

6.2 官方加载示例

文档地址: https://fastapi.tiangolo.com/zh/tutorial/bigger-applications/#fastapi

在主体文件main.py中,代码如下:

from fastapi import Depends, FastAPI
...
# 从routers导出路由文件:items, users
from .routers import items, users

# 挨个注册文件
app.include_router(users.router)
app.include_router(items.router)
app.include_router(
    admin.router,
    prefix="/admin",
    tags=["admin"],
    dependencies=[Depends(get_token_header)],
    responses={418: {"description": "I'm a teapot"}},
)
@app.get("/")
async def root():
    return {"message": "Hello Bigger Applications!"}

6.2 优化导入

1.编辑app/router/__init__.py
from app.router import default_router, demo_router

# 定义路由列表
RegisterRouterList = [
    default_router,
    demo_router
]

在__init__.py中定义变量,把要注册的路由统一放在列表中，然在main.py中通过循环加载路由；后续有新增路由时,直接在列表中新增元素即可；

2.修改main.py
import uvicorn
from fastapi import FastAPI
from app.router import RegisterRouterList

# 实例化
app = FastAPI()
# 加载路由 
for item in RegisterRouterList:
    app.include_router(item.router)

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

本文由 mdnice 多平台发布

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/1212863.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

Java设计模式-结构型模式-适配器模式

Java设计模式-结构型模式-适配器模式

适配器模式 适配器模式应用场景案例类适配器模式对象适配器模式接口适配器模式适配器模式在源码中的使用 适配器模式 如图：国外插座标准和国内不同，要使用国内的充电器，就需要转接插头，转接插头就是起到适配器的作用 适配器模式&…
阅读更多...
浪潮信息KeyarchOS迁移体验

浪潮信息KeyarchOS迁移体验

浪潮KOS迁移体验 文章目录 浪潮KOS迁移体验摘要CentOS 停更KOS简介 体验流程第一步，CentOS 体验第二部，迁移操作体验迁移评估迁移实施 第三步，软件功能验证操作系统验证终端登录 总结改进建议 关键字： 浪潮、 KOS、 X2Keyarch、…
阅读更多...
第十五届全国大学生数学竞赛初赛试卷解析

第十五届全国大学生数学竞赛初赛试卷解析

参加了此次比赛，收获很多，两个半小时让我体会到了很多，所以想做个总结 第十五届全国大学生数学竞赛初赛试题 （非数学A类,2023年） 下面是答案解析，有兴趣的小伙伴可以做完对照一下。 直接使用洛必…
阅读更多...
wireshark 抓包工俱使用一

wireshark 抓包工俱使用一

一、场景一 查询某个Http请求的请求数据和响应数据 请求示例如下（请求机器IP 172.20.2.164，目标地址：10.30.2.171） 过滤条件分析，请求协议http，请求数据和响应数据（http通信中请求和响应实际是两…
阅读更多...
【Ubuntu】Ubuntu20.04下安装视频播放器vlc和录屏软件ssr

【Ubuntu】Ubuntu20.04下安装视频播放器vlc和录屏软件ssr

【Ubuntu】Ubuntu20.04下安装视频播放器vlc和录屏软件ssr 文章目录 【Ubuntu】Ubuntu20.04下安装视频播放器vlc和录屏软件ssr1. 安装视频播放器vlc2. 安装录屏软件ssr 1. 安装视频播放器vlc sudo apt-get install vlcvlc是一款比较简洁的视频播放器，如下所示 2. 安…
阅读更多...
ASP.NET限流器的简单实现

ASP.NET限流器的简单实现

一、滑动时间窗口 我为RateLimiter定义了如下这个简单的IRateLimiter接口，唯一的无参方法TryAcquire利用返回的布尔值确定当前是否超出设定的速率限制。我只提供的两种基于时间窗口的实现，如下所示的基于“滑动时间窗口”的实现类型SliddingWindowRateL…
阅读更多...
【LeetCode刷题-滑动窗口】--1658.将x减到0的最小操作数

【LeetCode刷题-滑动窗口】--1658.将x减到0的最小操作数

1658.将x减到0的最小操作数 思路与算法： 根据题目描述，在每一次操作中，可以移除数组nums最左边和最右边的元素，因此，在所有的操作完成后，数组nums的一个前缀以及一个后缀被移除，并且它们的和恰…
阅读更多...
6.1810: Operating System Engineering ＜LEC 1＞

6.1810: Operating System Engineering ＜LEC 1＞

课程链接：6.1810 / Fall 2023 一、本节任务 实验环境： 二、introduction and examples 2.1 open(), read(), write(), close(), dup() 使用 open 打开或创建文件，得到文件描述符 fd，再对 fd 进行 read 或者 write 操作。每个进…
阅读更多...
绩效考核管理项目|记录1

绩效考核管理项目|记录1

项目用C#winformSQL Server写的，现在记录一下学习到的新东西。 winform工具 splitContainer：分割出两个容器，能添加面板之类的工具 treeview：展示标签页的分层集合（用户管理、基数管理......）&#xff0…
阅读更多...
现货黄金职业交易员怎么使用技术分析？

现货黄金职业交易员怎么使用技术分析？

职业的交易员每天要处理很多不同的信息，其中只一部分是涉及技术指标。在这一部分处理技术分析的时间里，只能再分出少之又少的时间给技术指标。那职业交易员会利用做技术指标做什么呢？下面我们就来讨论一下。 识别行情。技术指标的主要作用就是…
阅读更多...
codemirror怎么高亮指定文本

codemirror怎么高亮指定文本

先上图 ![在这里插入图片描述](https://img-blog.csdnimg.cn/c070cde11a314c45a859ccb0ca7f41c7.png 产品经理的需求是编辑框中用了占位符的话，占位符中的变量高亮，简单吧！还有一个附加要求，必须是外部定义的变量，不…
阅读更多...
单区域OSPF配置

单区域OSPF配置

配置命令步骤： 1.使用router ospf 进程ID编号 启用OSPF路由 2.使用network 直连网络地址 反掩码 area 0 将其归于区域0 注意：1.进程ID编号可任意（1-65535）2.反掩码用4个255相减得到 如下图，根据给出要求配置OSPF单区…
阅读更多...
【前端】使用json-server报错

【前端】使用json-server报错

当我们使用json-server模仿后端接口时需要运行json-server --watch index.json这个命令生成增删改查接口但是可能会报这个错误，如图 这时我们运行 npm i json-server -g命令即可，然后再重新运行json-server --watch index.json就行了
阅读更多...
如何快速将钉钉员工信息同步到飞书

如何快速将钉钉员工信息同步到飞书

当企业内部在使用钉钉跟飞书时，那么当钉钉员工信息发生更改时，我们应该如何将信息快速同步到飞书上呢，接下来我们借助RestCloud AppLink平台进行演示。 第一步：获得钉钉以及飞书认证授权 钉钉授权 钉钉接入采用自建应用的方式&…
阅读更多...
数字化档案管理系统解决方案

数字化档案管理系统解决方案

数字化档案管理系统解决方案是指将传统的纸质档案转化为数字化档案，采用计算机和网络技术实现对档案的存储、检索、管理、共享等操作的过程。 专久智能数字化档案管理解决方案及措施可以包括以下几个方面： 1. 采用数字化技术对档案进行数字化处理&#x…
阅读更多...
拜耳阵列（Bayer Pattern）以及常见彩色滤波矩阵（CFA）

拜耳阵列（Bayer Pattern）以及常见彩色滤波矩阵（CFA）

一、拜耳阵列的来源 图像传感器将光线转化成电流，光线越亮，电流的数值就越大；光线越暗，电流的数值就越小。图像传感器只能感受光的强弱，无法感受光的波长。由于光的颜色由波长决定，所以图像传播器无法记录…
阅读更多...
北大腾讯打造多模态15边形战士！语言作“纽带”，拳打脚踢各模态，超越Imagebind

北大腾讯打造多模态15边形战士！语言作“纽带”，拳打脚踢各模态，超越Imagebind

AI4Happiness 投稿 量子位 | 公众号 QbitAI 北大联合腾讯打造了一个多模态15边形战士！ 以语言为中心，“拳打脚踢”视频、音频、深度、红外理解等各模态。 具体来说，研究人员提出了一个叫做LanguageBind的多模态预训练框架。 用语言作为与其…
阅读更多...
如何在 Linux 上部署 RabbitMQ

如何在 Linux 上部署 RabbitMQ

如何在 Linux 上部署 RabbitMQ 文章目录 如何在 Linux 上部署 RabbitMQ安装 Erlang从预构建的二进制包安装从源代码编译 Erlang RabbitMQ 的安装使用 RabbitMQ Assistant 连接 RabbitMQ Assistant 是一款优秀的RabbitMQ 可视化管理工具，提供丰富的管理功能。下载地址…
阅读更多...
亚里士多德的思想统治西方世界，实体论证明人不是猪

亚里士多德的思想统治西方世界，实体论证明人不是猪

苏格拉底、柏拉图、亚里士多德，并称古希腊三贤。 公元前384年，亚里士多德出生在马其顿的奴隶主家庭，父亲是马其顿国王腓力二世的宫廷御医。 公元前367年，亚里士多德迁居到雅典，进入柏拉图学园，跟随柏拉图…
阅读更多...
systemverilog：interface中的modport用法

systemverilog：interface中的modport用法

使用modport可以将interface中的信号分组并指定方向，方向是从modport连接的模块看过来的。简单示例如下： interface cnt_if (input bit clk);logic rstn;logic load_en;logic [3:0] load;logic [7:0] count;modport TEST (input clk, count,output rst…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023