diff --git a/README.md b/README.md index 8cbcbefe8..b151bd240 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,9 @@ # FastAPI Best Architecture -English | [简体中文](./README.zh-CN.md) - Enterprise-level backend architecture solution -**🔥Continuously updated and maintained🔥** +English | [简体中文](./README.zh-CN.md) [![GitHub](https://img.shields.io/github/license/fastapi-practices/fastapi_best_architecture)](https://github.com/fastapi-practices/fastapi_best_architecture/blob/master/LICENSE) [![Python](https://img.shields.io/badge/python-3.10%2B-blue)](https://www.python.org/downloads/) @@ -21,12 +19,10 @@ Enterprise-level backend architecture solution ![Docker](https://img.shields.io/badge/Docker-%232496ED?logo=docker&logoColor=white) [![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?logo=discord&logoColor=white)](https://discord.com/invite/yNN3wTbVAC) ![Discord](https://img.shields.io/discord/1185035164577972344) +[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/fastapi-practices/fastapi_best_architecture) -> [!NOTE] -> This repository as a template library open to any person or enterprise can be used for free! - ## Pseudo 3-tier architecture The mvc architecture is a common design pattern in python web, but the 3-tier architecture is even more fascinating @@ -45,43 +41,7 @@ pattern, use templates to transform it to your heart's content! | data access | dao / mapper | crud | | model | model / entity | model | -## Features - -- [x] Global FastAPI PEP 593 Annotated parameter style -- [x] Comprehensive async/await + asgiref asynchronous design -- [x] Adheres to RESTful API specifications -- [x] Uses SQLAlchemy 2.0 with new syntax -- [x] Uses Pydantic v2 version -- [x] Implements role-menu RBAC access control -- [x] Integrates Casbin RBAC access control -- [x] Supports Celery asynchronous tasks -- [x] Custom-developed JWT authentication middleware -- [x] Supports global custom time zones -- [x] Supports Docker / Docker-compose deployment -- [x] Integrates Pytest unit testing - -## Built-in Functions - -- [x] User Management: Assign roles and permissions -- [x] Department Management: Configure organizational structure (company, department, team, etc.) -- [x] Menu Management: Set up menus and button-level permissions -- [x] Role Management: Configure roles, assign menus and permissions -- [x] Dictionary Management: Maintain common parameters and configurations -- [x] Parameter Management: Dynamically configure commonly used system parameters -- [x] Notification Announcements: Publish and maintain system notification and announcement information -- [x] Token Management: Detect online status, support forced logout -- [x] Multi-device Login: Support one-click switching between multi-device login modes -- [x] OAuth 2.0: Built-in custom-developed OAuth 2.0 authorization login -- [x] Plugin System: Hot-swappable plugin design to reduce coupling -- [x] Scheduled Tasks: Support scheduled, asynchronous tasks, and function calls -- [x] Code Generation: Automatically generate code with preview, write, and download support -- [x] Operation Logs: Record and query normal and abnormal operations -- [x] Login Logs: Record and query normal and abnormal logins -- [x] Cache Monitoring: Query system cache information and command statistics -- [x] Service Monitoring: View server hardware information and status -- [x] API Documentation: Automatically generate online interactive API documentation - -## Development and deployment +## Help For more details, please check the [official documentation](https://fastapi-practices.github.io/fastapi_best_architecture_docs/) diff --git a/README.zh-CN.md b/README.zh-CN.md index 49ffe3b20..752adf8d0 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -4,11 +4,9 @@ # FastAPI Best Architecture -简体中文 | [English](./README.md) - 企业级后端架构解决方案 -**🔥持续更新维护中🔥** +简体中文 | [English](./README.md) [![GitHub](https://img.shields.io/github/license/fastapi-practices/fastapi_best_architecture)](https://github.com/fastapi-practices/fastapi_best_architecture/blob/master/LICENSE) [![Python](https://img.shields.io/badge/python-3.10%2B-blue)](https://www.python.org/downloads/) @@ -21,12 +19,10 @@ ![Docker](https://img.shields.io/badge/Docker-%232496ED?logo=docker&logoColor=white) [![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?logo=discord&logoColor=white)](https://discord.com/invite/yNN3wTbVAC) ![Discord](https://img.shields.io/discord/1185035164577972344) +[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/fastapi-practices/fastapi_best_architecture) -> [!NOTE] -> 此仓库作为模板库公开，任何人或企业均可免费使用！ - ## 伪三层架构 mvc 架构作为常规设计模式，在 python web 中也很常见，但是三层架构更令人着迷 @@ -43,43 +39,7 @@ mvc 架构作为常规设计模式，在 python web 中也很常见，但是三 | 数据访问 | dao / mapper | crud | | 模型 | model / entity | model | -## 特性 - -- [x] 全局 FastAPI PEP 593 Annotated 参数风格 -- [x] 全面 async/await + asgiref 异步设计 -- [x] 遵循 RESTful API 规范 -- [x] 使用 SQLAlchemy 2.0 全新语法 -- [x] 使用 Pydantic v2 版本 -- [x] 实现角色菜单 RBAC 访问控制 -- [x] 集成 Casbin RBAC 访问控制 -- [x] 支持 Celery 异步任务 -- [x] 自研 JWT 认证中间件 -- [x] 支持全局自定义时间时区 -- [x] 支持 Docker / Docker-compose 部署 -- [x] 集成 Pytest 单元测试 - -## 内置功能 - -- [x] 用户管理：分配角色和权限 -- [x] 部门管理：配置组织架构（公司、部门、小组等） -- [x] 菜单管理：设置菜单及按钮级权限 -- [x] 角色管理：配置角色、分配菜单和权限 -- [x] 字典管理：维护常用参数和配置 -- [x] 参数管理：系统常用参数动态配置 -- [x] 通知公告：发布和维护系统通知公告信息 -- [x] 令牌管理：检测在线状态，支持强制下线 -- [x] 多端登录：支持一键切换多端登录模式 -- [x] OAuth 2.0：内置自研 OAuth 2.0 授权登录 -- [x] 插件系统：热插拔插件设计，降低耦合 -- [x] 定时任务：支持定时，异步任务及函数调用 -- [x] 代码生成：自动生成代码，支持预览、写入和下载 -- [x] 操作日志：记录和查询正常和异常操作 -- [x] 登录日志：记录和查询正常和异常登录 -- [x] 缓存监控：查询系统缓存信息和命令统计 -- [x] 服务监控：查看服务器硬件信息和状态 -- [x] 接口文档：自动生成在线交互式 API 文档 - -## 开发部署 +## 帮助 更多详情请查看 [官方文档](https://fastapi-practices.github.io/fastapi_best_architecture_docs/)