FastAPI
Path Operations & Dependency API Reference
FastAPI 基于类型注解构建高性能 API,支持自动校验、依赖注入与 OpenAPI 文档。
By EZ4Code Team
Path Operations
路径操作装饰器与依赖、异常、参数校验核心 API。
@app.get(path)注册一个 GET 路由处理函数。
Returns: 装饰器 — 包装后的路由函数
@app.post(path)注册一个 POST 路由处理函数,用于创建资源。
Returns: 装饰器 — 包装后的路由函数
FastAPI()创建 FastAPI 应用实例,可指定标题、版本等元信息。
Returns: FastAPI — 应用实例
Depends(dependency)声明依赖项,框架自动解析并注入其返回值。
Returns: 依赖对象 — 由框架解析后注入
HTTPException(status_code, detail)抛出 HTTP 异常,立即终止请求并返回指定状态码与详情。
Returns: HTTPException — 抛出后终止请求
BaseModelPydantic 模型基类,用于定义请求体/响应体的数据结构与校验规则。
Returns: BaseModel 子类 — 数据模型
Query(default) / Path(default)为查询参数或路径参数添加校验与元数据。
Returns: 参数对象 — 用于函数签名中声明约束
BackgroundTasks.add_task(func, *args)向后台任务队列添加函数,响应返回后再异步执行。
Returns: None — 任务加入队列,响应后执行