giancaldas/fastapi-project

giancaldas/fastapi-project镜像说明

镜像概述

本镜像提供了一套开箱即用的FastAPI后端开发模板，集成SQLAlchemy ORM（适配PostgreSQL数据库）、JWT身份认证机制及基础测试模块，旨在帮助开发者快速搭建符合RESTful规范的安全后端服务。

核心功能

1. FastAPI驱动：利用FastAPI的高性能特性，自动生成API文档（Swagger/OpenAPI）；
2. 数据库集成：通过SQLAlchemy ORM连接PostgreSQL，支持CRUD操作；
3. 身份认证：基于JWT实现令牌认证与权限控制；
4. 测试支持：包含基础测试用例，便于验证API功能。

使用场景

1. 快速开发后端API原型；
2. 学习FastAPI与SQLAlchemy的集成实践；
3. 构建需要JWT认证的业务系统后端（如用户管理、数据管理服务）。

配置说明

需通过环境变量配置以下参数：

• DATABASE_URL：PostgreSQL数据库连接地址（格式：postgresql://用户名:密码@主机:端口/数据库名）；
• JWT_SECRET_KEY：JWT签名密钥（需自定义安全字符串）；
• JWT_ALGORITHM：JWT加密算法（默认HS256）；
• ACCESS_TOKEN_EXPIRE_MINUTES：访问令牌过期时间（默认30分钟）。

部署示例

Docker Run命令

bash
docker run -d \
  -p 8000:8000 \
  -e DATABASE_URL="postgresql://user:pass@localhost:5432/mydb" \
  -e JWT_SECRET_KEY="your_secure_secret_key" \
  docker.xuanyuan.run/giancaldas/fastapi-project

Docker Compose示例

yaml
version: "3.8"
services:
  api:
    image: docker.xuanyuan.run/giancaldas/fastapi-project
    ports:
      - "8000:8000"
    environment:
      DATABASE_URL: "postgresql://user:pass@db:5432/mydb"
      JWT_SECRET_KEY: "your_secure_secret_key"
    depends_on:
      - db
  db:
    image: docker.xuanyuan.run/postgres:14
    environment:
      POSTGRES_USER: user
      POSTGRES_PASSWORD: pass
      POSTGRES_DB: mydb
    volumes:
      - postgres_data:/var/lib/postgresql/data

volumes:
  postgres_data:

部署后可访问http://localhost:8000/docs查看API文档。 ===FULL_DESC===