fastapi-practices/skills10 files

Fba

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.

Specification
Skill ID
fastapi-practices/skills/fba
Publisher
fastapi-practices
Repository
skills
Installs
0
Files
10
Synced
Sep 23, 2026
How to use it

Open any RiverX project, open the Skills panel in the chat, and search for this identifier. The files are fetched from the source repository at install time.

fastapi-practices/skills/fbaInstalls these files
  • SKILL.md
  • references/api.md
  • references/coding-style.md
  • references/config.md
  • references/development.md
  • references/model.md
  • references/naming.md
  • references/plugin-sharing.md
  • references/plugin.md
  • references/schema.md

What this skill tells the agent

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:

LayerResponsibility
APIRoute processing, parameter validation, and response return
SchemaData transfer objects, request/response data structure definitions
ServiceBusiness logic, data processing, exception handling
CRUDDatabase operations (inherits CRUDPlus)
ModelORM models (inherits Base)

Development Workflow

  1. Define database models (model)
  2. Define data validation models (schema)
  3. Define routes (router)
  4. Write business logic (service)
  5. Write database operations (crud)

Reference Selection

TaskRead
Feature/module development flow, Service/CRUD placement, pagination, cache, Celery, i18n, code generationreferences/development.md
API routes, dependencies, response patterns, auth, permissionsreferences/api.md
Pydantic request/response DTOsreferences/schema.md
SQLAlchemy models and migrationsreferences/model.md
CRUD, Service, API, Schema, entity and table prefix namingreferences/naming.md
Backend/frontend plugin development and plugin README filesreferences/plugin.md
Plugin sharing, public repositories, marketplace PRs, submodules, updatesreferences/plugin-sharing.md
Formatting, comments, docstrings, commit stylereferences/coding-style.md
Global settings and configurationreferences/config.md

Plugin Work

When creating, reviewing, or updating plugins:

  1. Read references/plugin.md for plugin type, structure, manifest, configuration, hooks, SQL, and README rules
  2. Read references/plugin-sharing.md when the task involves sharing, publishing, updating, marketplace PRs, plugin repositories, or Git submodules
  3. Prefer source-code behavior from fastapi-best-architecture when docs and implementation differ
  4. Do not perform git add, commit, push, or PR actions unless the user explicitly asks

CLI

Execute fba -h for more details.

Use this skill in a project

Open any RiverX project, search the Skills panel for fastapi-practices/skills/fba, and install it in one click.

Use this skill