Fba

What it does

This skill, Fba (FastAPI Best Architecture), provides a structured approach to developing FastAPI applications using a three-tier architecture. It organizes development into distinct layers: API for route processing and validation, Schema defining data structures, and Service handling business logic. The skill guides users through the process of creating database models, validating data, defining routes, and implementing business logic with associated CRUD operations.

When to use it

• When starting a new FastAPI project and wanting a well-defined architectural structure.
• For teams looking for consistent coding practices and clear separation of concerns in their FastAPI applications.
• To streamline the development workflow by providing pre-defined layers and responsibilities.
• When needing guidance on database operations, data validation, and API route design within a FastAPI context.

Key capabilities

• Three-Tier Architecture: Enforces a clear separation of concerns (API, Schema, Service).
• Data Validation: Provides schema definitions for request/response data structures.
• Database Operations (CRUD): Supports database interactions through CRUD operations inheriting from CRUDPlus.
• ORM Models: Facilitates the creation of ORM models based on a Base class.
• CLI Tooling: Offers command-line interface for development tasks (execute fba -h for details).

Example prompts

• "Generate a basic API route using Fba."
• "Show me an example of a data validation schema with Fba."
• "How do I define a database model in my FastAPI project using Fba?"

Tips & gotchas

• Familiarity with FastAPI and ORM concepts is helpful for effective use.
• The skill provides a framework; developers still need to implement the specific business logic within each layer.
• Refer to the official documentation (https://fastapi-practices.github.io/fastapi_best_architecture_docs/) for detailed guides on each component.