How do I add authentication to a fastapi-mvc project?

Fastapi-mvc doesn't include built-in authentication generators; you'll need to manually integrate FastAPI's security dependencies or middleware. The generated project structure provides a clear place for adding custom logic in controllers and models.

fastapi-mvc vs Django for building APIs?

Fastapi-mvc is focused on FastAPI for high-performance async APIs with MVC structure, while Django offers a full-stack framework with more built-in features like admin panels. Choose fastapi-mvc if you need modern Python async capabilities and lightweight tooling, but prefer Django for rapid development with batteries-included approach.

Can I use fastapi-mvc with an existing FastAPI codebase?

No, fastapi-mvc is designed for generating new projects from scratch; it doesn't support retrofitting its structure onto existing code. You'd need to manually migrate or start a new project and integrate legacy components.

How to customize the generated controllers in fastapi-mvc?

Edit the controller files in the app/controllers directory after generation—they follow standard Python classes. You can modify endpoints, add business logic, or use the CLI to regenerate parts while preserving custom changes cautiously.

What's the performance overhead of fastapi-mvc generated projects?

There's minimal runtime overhead as it's just a scaffolding tool; performance depends on your FastAPI code. However, the included production servers and tooling might add slight deployment complexity but not affect API response times significantly.

Is fastapi-mvc suitable for microservices?

It can be used for microservices due to its FastAPI base and Kubernetes support, but the MVC pattern might be heavier than needed. Consider if the structured approach aligns with your service boundaries or if a lighter setup is better.

Open-Awesome

FastAPI MVC

MITPython0.29.0

A CLI tool that generates production-ready FastAPI projects with MVC architecture, Kubernetes deployment, and full development tooling.

Visit Website GitHub

802 stars59 forks0 contributors

What is FastAPI MVC?

Fastapi-mvc is a command-line interface (CLI) tool that generates production-ready FastAPI projects with a Model-View-Controller (MVC) architecture. It solves the problem of repetitive setup by providing a complete foundation, including deployment configurations, documentation, and testing, so developers can start building APIs immediately.

Target Audience

Python developers and teams building FastAPI-based applications who want a standardized, production-ready project structure with minimal initial setup time.

Value Proposition

Developers choose Fastapi-mvc because it automates the boilerplate of setting up a FastAPI project, enforces best practices, and includes essential production tooling like Kubernetes deployment and comprehensive testing, which accelerates development and ensures consistency.

Overview

Developer productivity tool for making high-quality FastAPI production-ready APIs.

Use Cases

Best For

Quickly scaffolding new FastAPI projects with a consistent MVC structure
Teams needing production-ready deployment configurations for Kubernetes and Docker
Developers who want built-in code generators for controllers and endpoints
Projects requiring full test coverage and documentation from the start
Enforcing development best practices and standardized project layouts
Setting up reproducible development environments with Vagrant and Nix

Not Ideal For

Projects requiring a minimalist, non-MVC architecture or single-file APIs
Teams with established custom project templates that conflict with its conventions
Developers who prefer full control over dependency management and deployment without tooling overhead
Small-scale prototypes where comprehensive production setup adds unnecessary complexity

Pros & Cons

Pros

Comprehensive Project Scaffolding

Generates a complete FastAPI project with MVC structure, Dockerfile, and Kubernetes Helm charts, eliminating boilerplate setup. This includes a ready-to-use directory layout and production configurations as shown in the example.

Efficient Code Generators

CLI tools create controllers and endpoints automatically, reducing repetitive coding—demonstrated by the death_star controller example in the README. It also supports custom generators for extensibility.

Production-Ready Tooling

Includes WSGI + ASGI servers, GitHub Actions for CI/CD, and 100% test coverage out of the box, ensuring deployment and quality standards are met from the start.

Reproducible Development Environment

Integrates Vagrant and Nix for virtualized setups, making development consistent across teams. The README highlights installation via Nix flakes for reliability.

Cons

Rigid MVC Enforcement

Imposes a specific architectural pattern that may not align with all API designs, limiting flexibility for teams preferring other structures like microservices or event-driven architectures.

Complex Tooling Dependencies

Relies on multiple external tools like Poetry, Vagrant, and Nix, which can increase setup time and learning curve for developers unfamiliar with this ecosystem.

Potential Over-Engineering

The extensive scaffolding and tooling, while beneficial for large projects, can be bloated for simpler APIs, adding unnecessary files and configurations that might hinder rapid iteration.

Frequently Asked Questions

Related Projects

Manage FastAPI

:rocket: CLI tool for FastAPI. Generating new FastAPI projects & boilerplates made easy.

Stars1,905

Forks103

Last commit2 years ago

FastAPI Code Generator

This code generator creates FastAPI app from an openapi file.

api versioning for fastapi web applications

Stars845

Forks64