FastAPI Best Architecture
Official documentation: https://fastapi-practices.github.io/fastapi_best_architecture_docs/
Use this skill to follow fba architecture and plugin conventions. Read only the references needed for the task. For cross-layer feature work, read references/development.md first, then load the layer-specific references.
Core Architecture
Project adopts a layered backend architecture centered on API, Service, and CRUD, with Schema and Model as explicit data contracts:
| Layer |
Responsibility |
| API |
Route processing, parameter validation, and response return |
| Schema |
Data transfer objects, request/response data structure definitions |
| Service |
Business logic, data processing, exception handling |
| CRUD |
Database operations (inherits CRUDPlus) |
| Model |
ORM models (inherits Base) |
Development Workflow
- Define database models (model)
- Define data validation models (schema)
- Define routes (router)
- Write business logic (service)
- Write database operations (crud)
Reference Selection
| Task |
Read |
| Feature/module development flow, Service/CRUD placement, pagination, cache, Celery, i18n, code generation |
references/development.md |
| API routes, dependencies, response patterns, auth, permissions |
references/api.md |
| Pydantic request/response DTOs |
references/schema.md |
| SQLAlchemy models and migrations |
references/model.md |
| CRUD, Service, API, Schema, entity and table prefix naming |
references/naming.md |
| Backend/frontend plugin development and plugin README files |
references/plugin.md |
| Plugin sharing, public repositories, marketplace PRs, submodules, updates |
references/plugin-sharing.md |
| Formatting, comments, docstrings, commit style |
references/coding-style.md |
| Global settings and configuration |
references/config.md |
Plugin Work
When creating, reviewing, or updating plugins:
- Read
references/plugin.md for plugin type, structure, manifest, configuration, hooks, SQL, and README rules
- Read
references/plugin-sharing.md when the task involves sharing, publishing, updating, marketplace PRs, plugin repositories, or Git submodules
- Prefer source-code behavior from
fastapi-best-architecture when docs and implementation differ
- Do not perform git add, commit, push, or PR actions unless the user explicitly asks
CLI
Execute fba -h for more details.
1---2name: fba3description: FastAPI Best Architecture (fba) project development guide. Use when working in fba projects to design, implement, review, or document APIs, Schema, Service, CRUD, Model, configuration, response contracts, pagination, cache, Celery, i18n, coding style, plugin development, plugin README files, plugin sharing, plugin publishing, or plugin marketplace updates.4---5
6# FastAPI Best Architecture
7
8Official documentation: https://fastapi-practices.github.io/fastapi_best_architecture_docs/
9
10Use this skill to follow fba architecture and plugin conventions. Read only the references needed for the task. For cross-layer feature work, read `references/development.md` first, then load the layer-specific references.
11
12## Core Architecture
13
14Project adopts a layered backend architecture centered on API, Service, and CRUD, with Schema and Model as explicit data contracts:
15
16| Layer | Responsibility |
17|---------|--------------------------------------------------------------------|
18| API | Route processing, parameter validation, and response return |
19| Schema | Data transfer objects, request/response data structure definitions |
20| Service | Business logic, data processing, exception handling |
21| CRUD | Database operations (inherits `CRUDPlus`) |
22| Model | ORM models (inherits `Base`) |
23
24## Development Workflow
25
261. Define database models (model)
272. Define data validation models (schema)
283. Define routes (router)
294. Write business logic (service)
305. Write database operations (crud)
31
32## Reference Selection
33
34| Task | Read |
35|------|------|
36| Feature/module development flow, Service/CRUD placement, pagination, cache, Celery, i18n, code generation | `references/development.md` |
37| API routes, dependencies, response patterns, auth, permissions | `references/api.md` |
38| Pydantic request/response DTOs | `references/schema.md` |
39| SQLAlchemy models and migrations | `references/model.md` |
40| CRUD, Service, API, Schema, entity and table prefix naming | `references/naming.md` |
41| Backend/frontend plugin development and plugin README files | `references/plugin.md` |
42| Plugin sharing, public repositories, marketplace PRs, submodules, updates | `references/plugin-sharing.md` |
43| Formatting, comments, docstrings, commit style | `references/coding-style.md` |
44| Global settings and configuration | `references/config.md` |
45
46## Plugin Work
47
48When creating, reviewing, or updating plugins:
49
501. Read `references/plugin.md` for plugin type, structure, manifest, configuration, hooks, SQL, and README rules
512. Read `references/plugin-sharing.md` when the task involves sharing, publishing, updating, marketplace PRs, plugin repositories, or Git submodules
523. Prefer source-code behavior from `fastapi-best-architecture` when docs and implementation differ
534. Do not perform git add, commit, push, or PR actions unless the user explicitly asks
54
55## CLI
56
57Execute `fba -h` for more details.
fastapi-practices