Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fastapi-practices/fastapi_best_architecture
The RBAC permission control system built based on FastAPI adopts a unique pseudo-three-layer architecture design, built-in fastapi-admin basic implementation, and is free and open source as a template library.
https://github.com/fastapi-practices/fastapi_best_architecture
fastapi fastapi-admin fastapi-rbac fastapi-sqlalchemy fastapi-template pycasbin pydantic pydantic-v2
Last synced: about 1 month ago
JSON representation
The RBAC permission control system built based on FastAPI adopts a unique pseudo-three-layer architecture design, built-in fastapi-admin basic implementation, and is free and open source as a template library.
- Host: GitHub
- URL: https://github.com/fastapi-practices/fastapi_best_architecture
- Owner: fastapi-practices
- License: mit
- Created: 2023-04-07T05:21:11.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-09-28T07:05:18.000Z (about 2 months ago)
- Last Synced: 2024-09-29T02:21:37.613Z (about 2 months ago)
- Topics: fastapi, fastapi-admin, fastapi-rbac, fastapi-sqlalchemy, fastapi-template, pycasbin, pydantic, pydantic-v2
- Language: Python
- Homepage: https://fastapi-practices.github.io/fastapi_best_architecture_docs/
- Size: 5.04 MB
- Stars: 568
- Watchers: 12
- Forks: 97
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# FastAPI Best Architecture
[](https://github.com/fastapi-practices/fastapi_best_architecture/blob/master/LICENSE)
[](https://www.python.org/downloads/)
[](https://github.com/astral-sh/ruff)
[](https://pydantic.dev)
> [!NOTE]
> This repository as a template library open to any person or enterprise can be used for free!
English | [็ฎไฝไธญๆ](./README.zh-CN.md)
FastAPI framework based on the front-end and back-end separation of the middle and back-end solutions, follow
the [pseudo three-tier architecture](#pseudo-three-tier-architecture) design, support for **python3.10** and above
versions
**๐ฅContinuously updated and maintained๐ฅ**
## Pseudo three-tier architecture
The mvc architecture is a common design pattern in python web, but the three-tier architecture is even more fascinating
In python web development, there is no common standard for the concept of three-tier architecture, so we'll call it a
pseudo three-tier architecture here
But please note that we don't have a traditional multi-app structure (django, springBoot...) If you don't like this
pattern, use templates to transform it to your heart's content!
| workflow | java | fastapi_best_architecture |
|----------------|----------------|---------------------------|
| view | controller | api |
| data transmit | dto | schema |
| business logic | service + impl | service |
| data access | dao / mapper | crud |
| model | model / entity | model |
## Online Demo
You can view some of the preview screenshots
in [fastapi_best_architecture_ui](https://github.com/fastapi-practices/fastapi_best_architecture_ui)
Luckily, we now have a demo site: [FBA UI](https://fba.xwboy.top/)
> tester: test / 123456
>
> super: admin / 123456
## Features
- [x] Design with FastAPI PEP 593 Annotated Parameters
- [x] Global asynchronous design with async/await + asgiref
- [x] Follows Restful API specification
- [x] Global SQLAlchemy 2.0 syntax
- [x] Pydantic v1 and v2 (different branches)
- [x] Casbin RBAC access control model
- [x] Role menu RBAC access control model
- [x] Celery asynchronous tasks
- [x] JWT middleware whitelist authentication
- [x] Global customizable time zone time
- [x] Docker / Docker-compose deployment
- [x] Pytest Unit Testing
## Built-in features
- [x] User management: management of system user roles, assignment of permissions
- [x] Departmental management: Configuration of the system organization (company, department, group, ...)
- [x] Menu management: Configuration of system menus, user menus, button permission labels
- [x] Role management: assignment of role menu privileges, assignment of role routing privileges
- [x] Dictionary management: maintenance of commonly used fixed data or parameters within the system
- [x] Code generation: back-end code is automatically generated, supporting preview, write and download.
- [x] Operation log: logging and querying of normal and abnormal system operations.
- [x] Login authentication: graphical captcha backend authentication login
- [x] Logging: logging and querying of normal and abnormal user logins
- [x] Service monitoring: server hardware device information and status
- [x] Timed tasks: automated tasks, asynchronous tasks, support for function calls
- [x] Interface Documentation: Automatically generate online interactive API interface documentation.
## Project structure
```
โโ๐ backend--------------- # Backend
โโโโ๐ alembic------------- # DB migration
โโโโ๐ app----------------- # Application
โโโโโโ๐ admin------------- # System admin
โโโโโโโโ๐ api------------- # Interface
โโโโโโโโ๐ crud------------ # CRUD
โโโโโโโโ๐ model----------- # SQLA model
โโโโโโโโ๐ schema---------- # Data transmit
โโโโโโโโ๐ service--------- # Service
โโโโโโโโ๐ tests----------- # Pytest
โโโโโโ๐ generator--------- # Code generate
โโโโโโ๐ task-------------- # Celery task
โโโโ๐ common-------------- # public resources
โโโโ๐ core---------------- # Core configuration
โโโโ๐ database------------ # Database connection
โโโโ๐ log----------------- # Log
โโโโ๐ middleware---------- # Middlewares
โโโโ๐ scripts------------- # Scripts
โโโโ๐ sql----------------- # SQL files
โโโโ๐ static-------------- # Static files
โโโโ๐ templates----------- # Template files
โโโโ๐ utils--------------- # Toolkit
โโ๐ deploy---------------- # Server deployment
```
## Local development / Docker deployment
For more details, please check
the [official documentation](https://fastapi-practices.github.io/fastapi_best_architecture_docs/)
## Test data
Initialize the test data using the `backend/sql/init_test_data.sql` file.
## Development Process
(For reference only)
1. define the database model (model)
2. define the data validation model (schema)
3. define the view (api) and routing (router)
4. write business (service)
5. write database operations (crud)
## Testing
Execute unit tests through `pytest`.
1. create a test database `fba_test` with utf8mb4 encoding
2. create database tables using the `backend/sql/create_tables.sql` file
3. initialize the test data using the `backend/sql/init_pytest_data.sql` file
4. Go to the `backend` directory and execute the test commands.
```shell
cd backend/
pytest -vs --disable-warnings
```
## Status
## Contributors
## Special thanks
- [FastAPI](https://fastapi.tiangolo.com/)
- [Pydantic](https://docs.pydantic.dev/latest/)
- [SQLAlchemy](https://docs.sqlalchemy.org/en/20/)
- [Casbin](https://casbin.org/zh/)
- [Ruff](https://beta.ruff.rs/docs/)
- ...
## Interactivity
[TG / Discord](https://wu-clan.github.io/homepage/)
## Sponsor us
If this program has helped you, you can sponsor us with some coffee
beans: [:coffee: Sponsor :coffee:](https://wu-clan.github.io/sponsor/)
## License
This project is licensed by the terms of
the [MIT](https://github.com/fastapi-practices/fastapi_best_architecture/blob/master/LICENSE) license
[](https://starchart.cc/fastapi-practices/fastapi_best_architecture)