以下是一个使用 Python FastAPI 构建的 REST 接口样板代码，同时满足“用户注册功能开发”需求，并包含基础目录结构、必要的库导入以及初始化配置。
基础目录结构
project/
│
├── app/
│ ├── __init__.py
│ ├── main.py # FastAPI 应用主文件
│ ├── models/ # 数据模型目录
│ │ ├── __init__.py
│ │ ├── user.py # 用户相关模型
│ ├── schemas/ # 数据验证和序列化模式
│ │ ├── __init__.py
│ │ ├── user.py # 用户相关数据模式
│ ├── routers/ # 路由模块
│ │ ├── __init__.py
│ │ ├── user.py # 用户相关路由
│ ├── services/ # 核心业务逻辑层
│ │ ├── __init__.py
│ │ ├── user.py # 用户服务
│ └── config.py # 全局应用配置
│
├── requirements.txt # 项目依赖
├── .env # 环境配置（可选，如数据库连接字符串）
└── README.md # 项目介绍文档
样板代码实现
1. requirements.txt
需要的依赖可以放置在 requirements.txt 文件中：
fastapi
uvicorn
pydantic
sqlalchemy # 可选，如果需要数据库
python-decouple # 用于读取环境变量
2. app/config.py
全局配置文件，用于处理配置的动态加载：
from decouple import config
# 应用全局配置
class Settings:
PROJECT_NAME: str = "FastAPI User Registration"
VERSION: str = "1.0.0"
DEBUG: bool = config("DEBUG", cast=bool, default=True)
DATABASE_URL: str = config("DATABASE_URL", default="sqlite:///./test.db")
settings = Settings()
3. app/schemas/user.py
定义用户注册时的数据模型（输入/输出）：
from pydantic import BaseModel, EmailStr, Field
# 用户注册请求体
class UserCreate(BaseModel):
username: str = Field(..., min_length=3, max_length=30)
email: EmailStr
password: str = Field(..., min_length=6)
# 用户响应体（不包含敏感密码）
class UserResponse(BaseModel):
id: int
username: str
email: EmailStr
class Config:
orm_mode = True # 支持直接从 ORM 对象转换为 Pydantic 对象
4. app/models/user.py
定义数据库模型（如果你使用 SQLAlchemy）：
from sqlalchemy import Column, Integer, String
from sqlalchemy.ext.declarative import declarative_base
Base = declarative_base()
class User(Base):
__tablename__ = "users"
id = Column(Integer, primary_key=True, index=True)
username = Column(String, unique=True, index=True, nullable=False)
email = Column(String, unique=True, index=True, nullable=False)
hashed_password = Column(String, nullable=False)
5. app/services/user.py
业务逻辑层，处理注册业务：
from passlib.context import CryptContext
from sqlalchemy.orm import Session
from app.models.user import User
from app.schemas.user import UserCreate
# 密码加密工具
pwd_context = CryptContext(schemes=["bcrypt"], deprecated="auto")
def get_password_hash(password: str) -> str:
"""将明文密码哈希加密"""
return pwd_context.hash(password)
def create_user(db: Session, user_create: UserCreate):
"""在数据库中创建新用户"""
hashed_password = get_password_hash(user_create.password)
db_user = User(username=user_create.username, email=user_create.email, hashed_password=hashed_password)
db.add(db_user)
db.commit()
db.refresh(db_user)
return db_user
6. app/routers/user.py
定义用户相关路由和注册逻辑：
from fastapi import APIRouter, Depends, HTTPException
from sqlalchemy.orm import Session
from app.schemas.user import UserCreate, UserResponse
from app.services.user import create_user
from app.config import settings
from app.database import get_db # 数据库连接，这里需要额外实现
router = APIRouter(
prefix="/users",
tags=["Users"]
)
@router.post("/", response_model=UserResponse)
def register_user(user_create: UserCreate, db: Session = Depends(get_db)):
"""
用户注册路由
"""
# 检查是否已经存在同名用户/邮箱
existing_user = db.query(User).filter((User.username == user_create.username) | (User.email == user_create.email)).first()
if existing_user:
raise HTTPException(status_code=400, detail="Username or Email already exists")
created_user = create_user(db, user_create)
return created_user
7. app/main.py
主文件用于启动 FastAPI 应用：
from fastapi import FastAPI
from app.config import settings
from app.routers import user
app = FastAPI(
title=settings.PROJECT_NAME,
version=settings.VERSION,
debug=settings.DEBUG
)
# 包含用户注册的路由
app.include_router(user.router)
@app.get("/")
def read_root():
return {"message": "Welcome to FastAPI User Registration"}
启动应用
-
安装依赖：
pip install -r requirements.txt
-
启动应用：
uvicorn app.main:app --reload
-
测试接口：
- 打开浏览器访问
http://127.0.0.1:8000/docs 查看自动生成的 Swagger 文档。
- 测试用户注册接口：
POST /users。
可扩展性
- 如果使用数据库，可添加连接逻辑到
app/database.py 文件。
- 可通过中间件加入日志、权限验证等功能。
- 未来可以增加更多功能模块，例如用户登录、JWT 鉴权、用户信息更新等。
以上代码提供了一个完整的用户注册功能接口的基本脚手架，可以直接作为开发基础进行扩展或优化。
