mirror of https://github.com/fastapiadmin/FastapiAdmin.git synced 2026-10-14 05:00:10 +00:00

T

zhangtao b3882559de fix(storage): 修复类型检查暴露的三处缺陷（含 OSS 上传运行时 bug）

basedpyright 报出的三处，逐条定位后发现都不是「标注问题」：

1) oss_adapter.py:70 —— 真运行时 bug
   SDK 里 `Client.uploader` 是**方法**（`def uploader(self, **kwargs) -> Uploader`），
   原写法 `self.client.uploader.upload_file(...)` 是在绑定方法上取属性，运行时必抛
   AttributeError —— 即 OSS 上传链路从未成功过（生产未配 OSS 源，故未暴露）。
   已改为 `self.client.uploader().upload_file(...)`，并按 SDK 签名核对
   `upload_file(request, filepath, part_size=..., parallel_num=...)` 参数正确。

2) sftp_adapter.py:45 —— 缺主机校验
   `config.host` 为 `str | None`（对象存储可不填），却直接传给 paramiko
   `connect(hostname: str)`。已把 host 并入既有的用户名/密码守卫，
   缺主机时返回业务异常 400「SFTP 存储源必须配置主机、用户名与密码」。

3) ftp_ftps_adapter.py:58 —— 同上
   `_new_client()` 增加主机守卫（400「FTP 存储源必须配置主机地址」，并补 CustomException 导入）；
   顺带修复同文件 `_ImplicitFTP_TLS.connect` 覆写签名与 ftplib.FTP 不兼容
   （timeout: float、source_address: tuple[str, int] | None），消除该文件最后一条 error。

验证：basedpyright 这三个文件 0 errors（修复前 4 条）；ruff 全绿；pytest 97 passed；
      运行时探针：缺主机 → 拦截为 400 业务异常；配主机 → 守卫放行并进入真实连接（ConnectionRefused 如期）。

2026-10-04 05:49:27 +08:00

.github/workflows

chore(deploy): 成品部署链路、依赖分组与运维基建

2026-10-04 04:26:03 +08:00

backend

fix(storage): 修复类型检查暴露的三处缺陷（含 OSS 上传运行时 bug）

2026-10-04 05:49:27 +08:00

docker

chore(deploy): 健康检查发正确 Host、list 型配置改 JSON、Host 校验收窄

2026-10-04 05:12:37 +08:00

frontend

fix(web): 错误提示改为后端 msg 优先，去掉业务码白名单耦合

2026-10-04 05:44:26 +08:00

.dockerignore

chore(deploy): 成品部署链路、依赖分组与运维基建

2026-10-04 04:26:03 +08:00

.gitignore

chore(deploy): 成品部署链路、依赖分组与运维基建

2026-10-04 04:26:03 +08:00

AUDIT-REPORT.md

fix(storage): 修复类型检查暴露的三处缺陷（含 OSS 上传运行时 bug）

2026-10-04 05:49:27 +08:00

CHANGELOG.md

docs: 更新贡献指南，补充小程序开发说明

2026-09-06 21:19:58 +08:00

CONTRIBUTING.md

docs: 更新贡献指南，补充小程序开发说明

2026-09-06 21:19:58 +08:00

deploy-artifacts.sh

chore(deploy): 成品部署链路、依赖分组与运维基建

2026-10-04 04:26:03 +08:00

deploy.sh

chore(docker): 调整 dockerignore 排除上传目录

2026-09-07 01:38:38 +08:00

DEPLOYMENT.md

chore(deploy): 健康检查发正确 Host、list 型配置改 JSON、Host 校验收窄

2026-10-04 05:12:37 +08:00

LICENSE

chore: 更新项目所有者信息为fastapiadmin

2026-01-18 03:35:38 +08:00

README.en.md

docs(readme): 更新项目说明与界面截图

2026-09-06 20:52:11 +08:00

README.md

docs(readme): 更新项目说明与界面截图

2026-09-06 20:52:11 +08:00

REQUIREMENTS.md

docs: add SaaS multi-tenant platform requirements

2026-09-06 21:19:50 +08:00

SKILL.md

refactor(router): simplify route cache logic, remove nested parent component

2026-09-14 01:06:20 +08:00

README.en.md

FastApiAdmin ^v3.0.0

🚀 Exceptional Code Quality, Production-Ready Admin Dashboard in 5 Minutes

Full-stack rapid development platform powered by FastAPI + Vue3 + TypeScript. Web, H5, and Mini Program — all in one project.

English | 简体中文

🖥️ Screenshots

Web

Mobile (H5 / Mini Program / App from one codebase)

💡 Why FastapiAdmin?

You Need	FastapiAdmin	Django Admin	Frontend-Only
🎯 Ready-to-use admin system	✅	⚠️ Limited	❌ UI only
⚡ FastAPI async high-performance backend	✅	❌ Sync-first	❌ No backend
🔐 RBAC menu/button/data level permissions	✅	❌ Basic	❌
🤖 Code generator (table → full CRUD)	✅	❌	❌
📱 Mobile (H5 + Mini Program) included	✅	❌	❌
🐳 Docker one-click deploy (Nginx + SSL)	✅	❌	❌

👉 Full comparison: Why FastapiAdmin?

🍪 Live Demo

	URL	Account
💻 Web	service.fastapiadmin.com/web	`admin` / `123456`
📱 Mobile	service.fastapiadmin.com/app	`admin` / `123456`
📖 Official Docs	service.fastapiadmin.com	No login

🚀 5-Minute Quick Start

# 1. Clone
git clone https://github.com/fastapiadmin/FastapiAdmin.git

# 2. Configure environments
cp backend/env/.env.example backend/env/.env.dev
cp frontend/web/.env.development.example frontend/web/.env.development

# 3. Start backend (auto-creates tables + seed data on first run)
cd backend && uv sync && uv run main.py run --env=dev

# 4. Start frontend
cd ../frontend/web && pnpm install && pnpm run dev

# ✅ Open http://127.0.0.1:5173, login with admin/123456

Requirements
Python ≥ 3.12	Node.js ≥ 20 + pnpm
MySQL 8.0+ / PostgreSQL 14+	Redis 6.x / 7.x

🐳 Or: One-Command Docker Deployment

cp docker/.env.example docker/.env    # Fill in MySQL / Redis passwords
./deploy.sh                           # Build images and start the full stack (Nginx + SSL included)

For ports, SSL certificates and frontend builds, see the Docker deployment guide.

📦 Structure

FastapiAdmin/            # Monorepo full-stack project
├─ backend/              # FastAPI backend (Pydantic 2.0 + SQLAlchemy + Alembic)
├─ frontend/
│   ├── web/             # Vue3 Web (Element Plus + TypeScript)
│   ├── app/             # UniApp Mobile (H5 + Mini Program + App)
│   └── docs/            # VitePress documentation
├─ docker/               # Docker Compose deploy (Nginx + SSL)
├─ deploy.sh             # One-click deploy script
└─ LICENSE               # MIT

📌 Built-in Features

200+ REST endpoints · MySQL / PostgreSQL / SQLite · SFTP / S3 / OSS / COS / OBS storage adapters · Trim modules with a single ENABLED_MODULES entry

Core Modules (always enabled, cannot be removed)

Module	Capabilities
📊 Dashboard	Workbench, Analytics
⚙️ System Management	Users, Roles, Menus, Departments, Positions, Dicts, Config, Notices, Tickets, Versions
👀 Monitoring	Online users, Server monitoring, Cache monitoring
📝 Logs	Operation audit
🧰 Dev Tools	API Docs

Extension Modules (enabled by default, trim via `ENABLED_MODULES`)

Module	Capabilities	Toggle
🧩 Task Management	Scheduled tasks + visual workflow orchestration (built-in business nodes)	`task`
🔧 Code Generator	Table → full frontend/backend code	`generator`
📁 Storage	Unified file / object storage (SFTP / S3 / OSS / COS / OBS)	`storage`
🤖 AI Chat	Agno-powered agent conversations	`ai`
💬 Internal Chat	Text-only private / group chat between users (WebSocket real-time push + unread badge)	`chat`

🔧 Module Toggling

Extension modules can be enabled/disabled on demand via ENABLED_MODULES in backend/app/config/setting.py — just remove an item from the list; no code or menu deletion needed. The corresponding REST endpoints, WebSocket endpoints and initialization logic will not be loaded automatically:

# e.g. Disable internal chat and AI assistant, keep the rest
ENABLED_MODULES = ["generator", "task", "storage"]

🚦 Deployment Notes

Chat scope: Internal chat is positioned as lightweight internal communication — text-only messages. No file transfer, recall, read receipts, or multi-device sync (IM features). For strong IM needs, integrate mature products such as WeCom / DingTalk / Feishu. It can be disabled anytime by removing chat from ENABLED_MODULES.
Single-instance deployment: Real-time features (internal chat WebSocket, scheduled task scheduler) rely on in-memory connections and local scheduling within a single instance — please deploy as a single instance. For horizontal scaling, integrate Redis Pub/Sub or a message queue yourself.
Key security: Configure all third-party keys (AI, cloud storage, etc.) in the backend/env/.env.* environment variables. Never commit them to the repository or store them in the database.
Database migrations: Manage schema changes with Alembic migrations in production (uv run alembic upgrade head); create_all is only a fallback for first-time initialization.