fastapi框架
fastapi
,一个用于构建 API 的现代、快速(高性能)的异步web框架。
fastapi
是建立在Starlette和Pydantic基础上的
- Pydantic是一个基于Python类型提示来定义数据验证、序列化和文档的库。
- Starlette是一种轻量级的ASGI框架/工具包,是构建高性能Asyncio服务的理性选择。
- 快速:可与 NodeJS 和 Go 比肩的
极高性能
(归功于Starlette
和Pydantic
),是最快的 Python web 框架之一。- 高效编码:提高功能开发速度约 200% 至 300%。
- 更少bug:减少约 40% 的人为(开发者)导致错误。
- 智能:极佳的编辑器支持。处处皆可自动补全,减少调试时间。
- 简单:设计的
易于使用和学习
,阅读文档的时间更短。- 简短:使代码重复最小化。通过不同的参数声明实现丰富功能。
- 健壮:生产可用级别的代码。还有
自动生成的交互式文档
。
依赖:Python 3.6 及更高版本,FastAPI 站在以下巨人的肩膀之上
quick start
requirements.txt
annotated-types0.6.0
anyio4.2.0
click8.1.7
exceptiongroup1.2.0
fastapi0.63.0
h110.14.0
idna3.6
pydantic1.7.3
pydantic_core2.14.6
sniffio1.3.0
SQLAlchemy1.3.22
starlette0.13.6
typing_extensions4.9.0
uvicorn0.18.1
main.py
from fastapi import FastAPI # FastAPI 是一个为你的 API 提供了所有功能的 Python 类。app = FastAPI() # 这个实例将是创建你所有 API 的主要交互对象。这个 app 同样在如下命令中被 uvicorn 所引用@app.get("/")
async def root():return {"message": "Hello yuan"}
通过以下命令运行服务器:
uvicorn main:app --reload
INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO: Started reloader process [73408]
INFO: Started server process [73408]
INFO: Waiting for application startup
INFO: Application startup complete
也可以直接运行:
if __name__ == '__main__':import uvicornuvicorn.run("main:app", host="127.0.0.1", port=8080, debug=True, reload=True)
(1)导入 FastAPI。
(2)创建一个 app 实例。
(3)编写一个路径操作装饰器(如 @app.get(“/”))。
(4)编写一个路径操作函数(如上面的 def root(): …)
(5)定义返回值
(6)运行开发服务器(如 uvicorn main:app --reload)
此外,fastapi有着非常棒的交互式 API 文档,这一点很吸引人。
跳转到 http://127.0.0.1:8000/docs。你将会看到自动生成的交互式 API 文档。