FastAPI 测试服务器

此仓库包含一个基于 FastAPI 的测试服务器，用于 API 开发和测试。

概述

FastAPI 是一个现代的、高性能的 Python 3.7+ 网络框架，用于构建带有标准 Python 类型提示的 API。它旨在易于使用和学习，同时具备生产环境下的强大功能。

功能

• 快速：性能极高，与 NodeJS 和 Go 相媲美
• 直观：出色的编辑器支持（自动补全）
• 简单：设计为易于使用和学习
• 简洁：最大限度减少代码重复
• 稳健：生成生产就绪的代码，并带有交互式文档
• 基于标准：完全兼容开放标准 API 的开放标准，包括 OpenAPI 和 JSON Schema

入门指南

先决条件

• Python 3.7+
• pip（Python 包安装程序）

安装

# 创建一个虚拟环境
python -m venv venv
source venv/bin/activate  # 在 Windows 上：venv\Scripts\activate

# 安装 FastAPI 和 Uvicorn（ASGI 服务器）
pip install fastapi uvicorn

# 可选依赖项
pip install python-multipart  # 用于表单数据
pip install pydantic[email]   # 用于电子邮件验证

基本示例

创建一个文件 main.py，内容如下：

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def read_root():
    return {"Hello": "World"}

@app.get("/items/{item_id}")
def read_item(item_id: int, q: str = None):
    return {"item_id": item_id, "q": q}

运行服务器

uvicorn main:app --reload

服务器将运行在 http://127.0.0.1:8000

API 文档

FastAPI 会自动生成交互式 API 文档：

• Swagger UI：http://127.0.0.1:8000/docs
• ReDoc：http://127.0.0.1:8000/redoc

项目结构

.
├── app/
│   ├── __init__.py
│   ├── main.py          # FastAPI 应用程序
│   ├── dependencies.py  # 依赖项、中间件等
│   ├── routers/         # API 路由模块
│   ├── models/          # Pydantic 模型
│   ├── schemas/         # 请求/响应模式
│   ├── crud/            # 数据库 CRUD 操作
│   ├── db/              # 数据库模型和配置
│   └── core/            # 核心功能
├── tests/               # 测试模块
├── .env                 # 环境变量
├── .gitignore
├── requirements.txt
└── README.md

部署

FastAPI 应用程序可以部署在多个平台上：

• Docker
• Heroku
• AWS Lambda
• Google Cloud Run
• Azure Functions
• 传统的服务器（使用 Gunicorn/Uvicorn）

贡献

欢迎贡献！请随意提交 Pull Request。

许可证

此项目根据 MIT License 分发，详见 LICENSE 文件。