FASTAPI系列 01 环境准备 & FASTAPI系列 02-简单入门
一、FASTAPI系列 01 环境准备
前言
FastAPI
是一个用于构建 API
的现代、快速(高性能)的 Python Web 框架
,由 Sebastián Ramírez
创建,适用于 Python 3.6
及更高版本。
提示:以下是本篇文章正文内容,下面案例可供参考
一、FASTAPI简介
-
快速性能:
FastAPI
利用Python
的异步特性(asyncio
)实现了高并发和低延迟,性能表现可媲美Node.js
和Go语言
编写的同类应用。 -
高效编码:
FastAPI
基于Python类型
提示系统,这不仅有助于提高代码质量和可读性,而且还允许框架根据类型提示自动生成路由、请求体解析、参数验证等,极大地提升了开发效率,据称可以将开发速度提高200%
至300%
。 -
较少的
Bug
:通过Pydantic
进行严格的类型检查和数据验证,FastAPI
能够在编译阶段捕获许多潜在的错误,从而降低开发者因类型错误或数据问题引入的Bug
。 -
智能编辑器支持:由于对类型提示的良好支持,
FastAPI 开发者能
在IDE
中享受到丰富的自动补全和实时错误检查功能。 -
自动文档生成:
FastAPI
自动根据代码中的类型提示生成交互式的API 文档
,兼容OpenAPI
规范(Swagger UI
和ReDoc
),简化了API
的管理和使用。 -
数据验证和转换:使用
Pydantic
实现的数据模型可以直接应用于请求体和响应体,确保输入输出数据的有效性和一致性。 -
依赖注入:内置对依赖注入的支持,使得服务之间解耦更加容易,增强了模块化和可测试性。
-
扩展性:支持
WebSocket
和GraphQL
,方便构建实时通信和灵活查询的API
,适应多种复杂应用场景。
二、环境准备
1.快速安装fastapi以及相关依赖
pip install fastapi[all]
2.创建项目
使用pycharm
创建一个fastapi
的demo项目
安装对应fastpai
的依赖包
安装成功显示Successfully
创建main.py文件
,导入fastapi
确定安装成功
总结
FastAPI
环境准备的核心工作包括正确安装FastAPI
及相关工具链,并在适当的项目结构中初始化应用代码,确保所有依赖都得到妥善配置和管理
二、FASTAPI系列 02-简单入门
实现一个简单的例子
编写一个简单的get请求
,请求/first路径
,返回一个接口报文 {“message”:“Hello,Word!”}
创建一个main.py 文件
,代码如下:
from fastapi import FastAPI
# 导入FastAPI模块并创建一个FastAPI实例
app = FastAPI()
# 使用装饰器@app.get("/")定义一个GET请求处理函数(endpoint)
# 当用户访问应用的根路径 "/" 时,root函数会被调用
@app.get("/first")
async def root():
# 函数返回一个字典,内容为 {"message": "Hello World"}
# 这个字典会被自动转换成JSON格式返回给客户端
return {"message": "Hello World"}
if __name__ == "__main__":
import uvicorn
uvicorn.run(app, host="0.0.0.0", port=8000)
执行main函数
方法,启动服务:
uvicorn.run(app, host=“0.0.0.0”, port=8000)
是在使用 Uvicorn 服务器
启动一个 Web 应用程序
时的命令。Uvicorn
是一个高性能 ASGI(Asynchronous Server Gateway Interface)服务器
,特别适合服务于基于 Python
的异步框架,比如 FastAPI
;
-
uvicorn.run
: 这是Uvicorn 模块
提供的一个函数,它负责启动Web 服务器
并运行指定的应用程序实例。 -
app
: 这是您要运行的应用程序对象,通常是FastAPI
或Starlette
创建的一个应用实例。这个对象包含了您的路由、视图函数等构成Web 服务
的所有内容。 -
host=“0.0.0.0”
: 这个参数指定了服务器监听的主机地址。在这里,设置为 “0.0.0.0
” 表示服务器将在所有可用网络接口上监听,包括本地回环接口(localhost
)和任何公开的网络接口,这意味着其他设备可以通过该服务器所在的机器的IP 地址
访问此服务。 -
port=8000
: 这是指定服务器监听的端口号,这里是8000
。通过这个端口,客户端可以通过HTTP 协议
与服务器进行通信。例如,要访问运行在此服务器上的应用,用户可以在浏览器中输入http://your_server_ip:8000
。
使用浏览器访问:http://127.0.0.1:8000/first, 显示返回报文
FASTAPI
的swagger 文档
,交互式API
使用swagger
调用接口
标签:02,系列,FASTAPI,fastapi,0.0,服务器,FastAPI From: https://blog.csdn.net/weixin_54626591/article/details/139419612