素材阁

FastAPI 速查

共 24 条 FastAPI 常用写法与命令,涵盖最小应用、参数与请求体、依赖与中间件、响应与错误、命令与部署。 支持搜索与分类筛选,点击即可复制。

最小应用

基于类型注解的现代框架。

命令说明
创建应用
定义 GET 接口
定义 POST 接口(异步)
启动开发服务器
自动生成的交互式 API 文档

参数与请求体

类型注解即校验。

命令说明
查询参数(默认值即可选)
路径参数(自动类型转换)
Pydantic 模型(请求体)
可选字段
字段校验约束

依赖与中间件

依赖注入很强大。

命令说明
依赖注入(Depends)
认证依赖(Bearer Token)
添加中间件(如跨域)
启动事件(连接池初始化等)
路由分组(APIRouter)

响应与错误

返回与异常处理。

命令说明
声明响应模型(过滤 / 校验输出)
抛出 HTTP 错误
全局异常处理器
指定成功状态码
自定义响应

命令与部署

运行与打包。

命令说明
安装依赖
生产多进程(需搭配 gunicorn)
Gunicorn + Uvicorn 部署
导出依赖

使用说明

FastAPI 速查:最小应用、参数与请求体、依赖与中间件、响应与错误、命令与部署;支持搜索与分类筛选,点击即可复制。

  1. 按用途点分类:最小应用、参数与请求体、依赖与中间件、响应与错误、命令与部署。
  2. 点「命令」列复制代码片段。
  3. 启动:uvicorn main:app --reload,浏览器打开 /docs 看交互文档。
  4. 请求体用 Pydantic 模型声明,框架自动做校验与转换。

常见问题

参数校验要额外库吗?
不用,FastAPI 基于类型注解与 Pydantic 自动校验,配合 Field 可加范围约束。
生产环境怎么部署?
用 Gunicorn + UvicornWorker 多进程,或容器里直接跑 uvicorn 并配合反向代理。
需要联网吗?
不需要,本地可用。

延伸阅读

相关工具