ホーム

FastAPI-fastkit

FastAPI-fastkit: Python と FastAPI を初めて使う方のための、速くて使いやすいスターターキット

このプロジェクトは、Python と FastAPI を初めて使う方が、Python ベースの Web アプリ開発をより早く始められるように作られました。

このプロジェクトは SpringBoot initializer と Python Django の django-admin CLI から着想を得ています。

翻訳ステータス

このドキュメントの 原典は英語 (en) です。言語切替メニューに表示される他のロケールは部分翻訳の状態であったり、ページ単位で英語にフォールバックする場合があります。各ロケールの実際の翻訳進捗は翻訳ステータスを参照してください。

主な機能

⚡ FastAPI プロジェクトを即座に作成: Python Django の django-admin 機能から着想を得て、CLI から FastAPI のワークスペースとプロジェクトを高速生成
✨ 対話型プロジェクトビルダー: データベース、認証、キャッシュ、モニタリングなどを段階的に選択し、選択内容を反映したコードを自動生成
🎨 見やすい CLI 出力: rich library を使った読みやすい CLI 体験
📋 標準準拠の FastAPI プロジェクトテンプレート: FastAPI-fastkit のすべてのテンプレートは Python の標準と FastAPI の一般的な利用パターンに基づいて構成
🔍 自動化されたテンプレート品質保証: 週次の自動テストですべてのテンプレートが動作し最新であることを保証
🚀 多彩なプロジェクトテンプレート: async CRUD、Docker、PostgreSQL など、ユースケース別の事前構成テンプレートを用意
📦 複数のパッケージマネージャーに対応: 好みの Python パッケージマネージャー (pip、uv、pdm、poetry) を選択可能

インストール

Python 環境に FastAPI-fastkit をインストールしましょう。

$ pip install FastAPI-fastkit
---> 100%

使い方

新しい FastAPI プロジェクトの開発環境をすぐに作成

FastAPI-fastkit を使えば、新しい FastAPI プロジェクトをすばやく開始できます。

次のコマンドで、新しい FastAPI プロジェクトの開発環境をすぐに作成できます:

$ fastkit init
Enter the project name: my-awesome-project
Enter the author name: John Doe
Enter the author email: john@example.com
Enter the project description: My awesome FastAPI project

           Project Information
┌──────────────┬────────────────────────────┐
│ Project Name │ my-awesome-project         │
│ Author       │ John Doe                   │
│ Author Email │ john@example.com           │
│ Description  │ My awesome FastAPI project │
└──────────────┴────────────────────────────┘

Available Stacks and Dependencies:
           MINIMAL Stack
┌──────────────┬───────────────────┐
│ Dependency 1 │ fastapi           │
│ Dependency 2 │ uvicorn           │
│ Dependency 3 │ pydantic          │
│ Dependency 4 │ pydantic-settings │
└──────────────┴───────────────────┘

           STANDARD Stack
┌──────────────┬───────────────────┐
│ Dependency 1 │ fastapi           │
│ Dependency 2 │ uvicorn           │
│ Dependency 3 │ sqlalchemy        │
│ Dependency 4 │ alembic           │
│ Dependency 5 │ pytest            │
│ Dependency 6 │ pydantic          │
│ Dependency 7 │ pydantic-settings │
└──────────────┴───────────────────┘

             FULL Stack
┌──────────────┬───────────────────┐
│ Dependency 1 │ fastapi           │
│ Dependency 2 │ uvicorn           │
│ Dependency 3 │ sqlalchemy        │
│ Dependency 4 │ alembic           │
│ Dependency 5 │ pytest            │
│ Dependency 6 │ redis             │
│ Dependency 7 │ celery            │
│ Dependency 8 │ pydantic          │
│ Dependency 9 │ pydantic-settings │
└──────────────┴───────────────────┘

Select stack (minimal, standard, full): minimal

Available Package Managers:
                   Package Managers
┌────────┬────────────────────────────────────────────┐
│ PIP    │ Standard Python package manager            │
│ UV     │ Fast Python package manager                │
│ PDM    │ Modern Python dependency management        │
│ POETRY │ Python dependency management and packaging │
└────────┴────────────────────────────────────────────┘

Select package manager (pip, uv, pdm, poetry) [uv]: uv
Do you want to proceed with project creation? [y/N]: y
FastAPI project will deploy at '~your-project-path~'

╭──────────────────────── Info ────────────────────────╮
│ ℹ Injected metadata into setup.py                    │
╰──────────────────────────────────────────────────────╯
╭──────────────────────── Info ────────────────────────╮
│ ℹ Injected metadata into config file                 │
╰──────────────────────────────────────────────────────╯

        Creating Project:
       my-awesome-project
┌───────────────────┬───────────┐
│ Component         │ Collected │
│ fastapi           │ ✓         │
│ uvicorn           │ ✓         │
│ pydantic          │ ✓         │
│ pydantic-settings │ ✓         │
└───────────────────┴───────────┘

Creating virtual environment...

╭──────────────────────── Info ────────────────────────╮
│ ℹ venv created at                                    │
│ ~your-project-path~/my-awesome-project/.venv         │
│ To activate the virtual environment, run:            │
│                                                      │
│     source                                           │
│ ~your-project-path~/my-awesome-project/.venv/bin/act │
│ ivate                                                │
╰──────────────────────────────────────────────────────╯

Installing dependencies...
⠙ Setting up project environment...Collecting <packages~>

---> 100%

╭─────────────────────── Success ───────────────────────╮
│ ✨ Dependencies installed successfully                │
╰───────────────────────────────────────────────────────╯
╭─────────────────────── Success ───────────────────────╮
│ ✨ FastAPI project 'my-awesome-project' has been      │
│ created successfully and saved to                     │
│ ~your-project-path~!                                  │
╰───────────────────────────────────────────────────────╯
╭──────────────────────── Info ────────────────────────╮
│ ℹ To start your project, run 'fastkit runserver' at  │
│ newly created FastAPI project directory              │
╰──────────────────────────────────────────────────────╯

このコマンドは、Python の仮想環境を含む新しい FastAPI プロジェクトの開発環境を作成します。

対話型モードでプロジェクトを作成 ✨ NEW!

より複雑なプロジェクトには、対話型モード を使って、賢い機能選択とともに段階的に FastAPI アプリケーションを組み立てましょう:

$ fastkit init --interactive

⚡ FastAPI-fastkit Interactive Project Setup ⚡

📋 Basic Project Information
Enter the project name: my-fullstack-project
Enter the author name: John Doe
Enter the author email: john@example.com
Enter the project description: Full-stack FastAPI project with PostgreSQL and JWT

🧱 Architecture Preset
Pick a project layout. Press Enter to accept the recommended default.
  1. minimal           - Smallest viable FastAPI app
  2. single-module     - Everything in one module (prototypes / scripts)
  3. classic-layered   - api/routes + crud + schemas + core (à la fastapi-default)
  4. domain-starter    - Domain-oriented src/app/domains/<concept>/ (recommended)

Select architecture preset: [4]

🗄️ Database Selection
Select database (PostgreSQL, MySQL, MongoDB, Redis, SQLite, None):
  1. PostgreSQL - PostgreSQL database with SQLAlchemy
  2. MySQL - MySQL database with SQLAlchemy
  3. MongoDB - MongoDB with motor async driver
  4. Redis - Redis for caching and session storage
  5. SQLite - SQLite database for development
  6. None - No database

Select database: 1

🔐 Authentication Selection
Select authentication (JWT, OAuth2, FastAPI-Users, Session-based, None):
  1. JWT - JSON Web Token authentication
  2. OAuth2 - OAuth2 with password flow
  3. FastAPI-Users - Full featured user management
  4. Session-based - Cookie-based sessions
  5. None - No authentication

Select authentication: 1

⚙️ Background Tasks Selection
Select background tasks (Celery, Dramatiq, None):
  1. Celery - Distributed task queue
  2. Dramatiq - Fast and reliable task processing
  3. None - No background tasks

Select background tasks: 1

💾 Caching Selection
Select caching (Redis, fastapi-cache2, None):
  1. Redis - Redis caching
  2. fastapi-cache2 - Simple caching for FastAPI
  3. None - No caching

Select caching: 1

📊 Monitoring Selection
Select monitoring (Loguru, OpenTelemetry, Prometheus, None):
  1. Loguru - Simple and powerful logging
  2. OpenTelemetry - Observability framework
  3. Prometheus - Metrics and monitoring
  4. None - No monitoring

Select monitoring: 3

🧪 Testing Framework Selection
Select testing framework (Basic, Coverage, Advanced, None):
  1. Basic - pytest + httpx for API testing
  2. Coverage - Basic + code coverage
  3. Advanced - Coverage + faker + factory-boy for fixtures
  4. None - No testing framework

Select testing framework: 2

🛠️ Additional Utilities
Select utilities (comma-separated numbers, e.g., 1,3,4):
  1. CORS - Cross-Origin Resource Sharing
  2. Rate-Limiting - Request rate limiting
  3. Pagination - Pagination support
  4. WebSocket - WebSocket support

Select utilities: 1

🚀 Deployment Configuration
Select deployment option:
  1. Docker - Generate Dockerfile
  2. docker-compose - Generate docker-compose.yml (includes Docker)
  3. None - No deployment configuration

Select deployment option: 2

📦 Package Manager Selection
Select package manager (pip, uv, pdm, poetry): uv

📝 Custom Packages (optional)
Enter custom package names (comma-separated, press Enter to skip):

📋 Project Configuration Summary
┌─────────────────────┬───────────────────────────────────────────────────────────────────────────┐
│ Setting             │ Value                                                                     │
├─────────────────────┼───────────────────────────────────────────────────────────────────────────┤
│ Project Name        │ my-fullstack-project                                                      │
│ Author              │ John Doe                                                                  │
│ Email               │ john@example.com                                                          │
│ Description         │ Full-stack FastAPI project with PostgreSQL and JWT                        │
│ Architecture Preset │ domain-starter — Domain-oriented: src/app/domains/<concept>/ (recommended)│
│ Database            │ PostgreSQL                                                                │
│ Authentication      │ JWT                                                                       │
│ Async Tasks         │ Celery                                                                    │
│ Caching             │ Redis                                                                     │
│ Monitoring          │ Prometheus                                                                │
│ Testing             │ Coverage                                                                  │
│ Utilities           │ CORS                                                                      │
│ Package Manager     │ uv                                                                        │
└─────────────────────┴───────────────────────────────────────────────────────────────────────────┘

Total dependencies to install: 18

Proceed with project creation? [Y/n]: y

╭──────────────────────── Info ────────────────────────╮
│ ℹ Injected metadata into pyproject.toml              │
╰──────────────────────────────────────────────────────╯
╭─────────────────────── Success ───────────────────────╮
│ ✨ Generated dependency file with 18 packages         │
╰───────────────────────────────────────────────────────╯
╭──────────────────────── Info ────────────────────────╮
│ ℹ Preserving template-shipped main.py for preset     │
│ 'domain-starter'.                                    │
╰──────────────────────────────────────────────────────╯
╭─────────────────────── Success ───────────────────────╮
│ ✨ Generated Docker deployment files                  │
╰───────────────────────────────────────────────────────╯
╭────────────────────── Warning ────────────────────────╮
│ ⚠ Preset compatibility                               │
│ fastapi-domain-starter's shipped src/app/main.py is  │
│ preserved. The selections below need manual wiring   │
│ there (CORS is already wired — set                   │
│ BACKEND_CORS_ORIGINS in .env to activate it).        │
│ Affected selections (packages installed, but no      │
│ dynamic main.py edits applied for the                │
│ 'domain-starter' preset): Prometheus                 │
╰───────────────────────────────────────────────────────╯
╭─────────────────────── Success ───────────────────────╮
│ ✨ Generated configuration files for selected stack   │
╰───────────────────────────────────────────────────────╯

Creating virtual environment...
Installing dependencies...

----> 100%

╭─────────────────────── Success ───────────────────────╮
│ ✨ FastAPI project 'my-fullstack-project' from        │
│ 'fastapi-domain-starter' has been created!            │
╰───────────────────────────────────────────────────────╯

対話型モードが提供する機能:

アーキテクチャプリセット選択 (minimal / single-module / classic-layered / domain-starter) — 適切なベーステンプレートとプロジェクトレイアウトを決定
データベース、認証、バックグラウンドタスク、キャッシュ、モニタリングなどに対する ガイド付き選択
選択した機能向けの コードの自動生成 — プリセットに応じて挙動が異なる (minimal / single-module は main.py を再生成、classic-layered / domain-starter はテンプレート同梱の main.py を保存し、設定モジュールのみ追加)
プリセット対応の Docker 生成 — 生成された Dockerfile の CMD がそのプリセットの実際のエントリポイント (src.main:app または src.app.main:app) を指す
自動 pip 互換性を備えた スマートな依存関係管理
プリセットが自動配線できない選択について手動配線の警告を出力する 機能検証
生成された pyproject.toml への 識別マーカー 注入 (description マーカー + [tool.fastapi-fastkit] テーブル) — 後で is_fastkit_project() が生成済みプロジェクトを認識可能

FastAPI プロジェクトに新しいルートを追加

FastAPI-fastkit は FastAPI プロジェクトの拡張を簡単にします。

次のコマンドで FastAPI プロジェクトに新しいルートエンドポイントを追加できます:

$ fastkit addroute user my-awesome-project
                       Adding New Route
┌──────────────────┬──────────────────────────────────────────┐
│ Project          │ my-awesome-project                       │
│ Route Name       │ user                                     │
│ Target Directory │ ~your-project-path~                      │
└──────────────────┴──────────────────────────────────────────┘

Do you want to add route 'user' to project 'my-awesome-project'? [Y/n]: y

╭──────────────────────── Info ────────────────────────╮
│ ℹ Updated main.py to include the API router          │
╰──────────────────────────────────────────────────────╯
╭─────────────────────── Success ───────────────────────╮
│ ✨ Successfully added new route 'user' to project     │
│ `my-awesome-project`                                  │
╰───────────────────────────────────────────────────────╯

構造化された FastAPI デモプロジェクトを即座に展開

構造化された FastAPI デモプロジェクトから始めることもできます。

デモプロジェクトはさまざまな技術スタックで構成されており、シンプルな item CRUD エンドポイントが実装されています。

次のコマンドで、構造化された FastAPI デモプロジェクトを即座に展開できます:

$ fastkit startdemo
Enter the project name: my-awesome-demo
Enter the author name: John Doe
Enter the author email: john@example.com
Enter the project description: My awesome FastAPI demo
Deploying FastAPI project using 'fastapi-default' template
Template path:
/~fastapi_fastkit-package-path~/fastapi_project_template/fastapi-default

           Project Information
┌──────────────┬─────────────────────────┐
│ Project Name │ my-awesome-demo         │
│ Author       │ John Doe                │
│ Author Email │ john@example.com        │
│ Description  │ My awesome FastAPI demo │
└──────────────┴─────────────────────────┘

       Template Dependencies
┌──────────────┬───────────────────┐
│ Dependency 1 │ fastapi           │
│ Dependency 2 │ uvicorn           │
│ Dependency 3 │ pydantic          │
│ Dependency 4 │ pydantic-settings │
│ Dependency 5 │ python-dotenv     │
└──────────────┴───────────────────┘

Available Package Managers:
                   Package Managers
┌────────┬────────────────────────────────────────────┐
│ PIP    │ Standard Python package manager            │
│ UV     │ Fast Python package manager                │
│ PDM    │ Modern Python dependency management        │
│ POETRY │ Python dependency management and packaging │
└────────┴────────────────────────────────────────────┘

Select package manager (pip, uv, pdm, poetry) [uv]: uv
Do you want to proceed with project creation? [y/N]: y
FastAPI template project will deploy at '~your-project-path~'

---> 100%

╭─────────────────────── Success ───────────────────────╮
│ ✨ Dependencies installed successfully                │
╰───────────────────────────────────────────────────────╯
╭─────────────────────── Success ───────────────────────╮
│ ✨ FastAPI project 'my-awesome-demo' from             │
│ 'fastapi-default' has been created and saved to       │
│ ~your-project-path~!                                  │
╰───────────────────────────────────────────────────────╯

利用可能な FastAPI デモの一覧を表示するには、次のコマンドを実行してください:

$ fastkit list-templates
                              Available Templates
┌────────────────────────┬───────────────────────────────────────────────────────┐
│ fastapi-custom-response│ Async Item Management API with Custom Response System │
│ fastapi-mcp            │ FastAPI MCP Project                                   │
│ fastapi-domain-starter │ FastAPI Domain Starter                                │
│ fastapi-dockerized     │ Dockerized FastAPI Item Management API                │
│ fastapi-empty          │ Minimal FastAPI Template                              │
│ fastapi-async-crud     │ Async Item Management API Server                      │
│ fastapi-psql-orm       │ Dockerized FastAPI Item Management API with           │
│                        │ PostgreSQL                                            │
│ fastapi-default        │ Simple FastAPI Project                                │
│ fastapi-single-module  │ FastAPI Single Module Template                        │
└────────────────────────┴───────────────────────────────────────────────────────┘

ドキュメント

包括的なガイドと詳細な使い方は、ドキュメントを参照してください:

📚 ユーザーガイド - 詳細なインストール / 利用ガイド
🎯 チュートリアル - 初心者向けの段階的なチュートリアル
📖 CLI リファレンス - コマンドの完全リファレンス
🔍 テンプレート品質保証 - 自動化されたテストと品質基準

🚀 テンプレート別チュートリアル

事前構築されたテンプレートを使った実践的なユースケースで、FastAPI 開発を学びましょう:

📖 コアチュートリアル

基本 API サーバーの構築 - fastapi-default テンプレートで初めての FastAPI サーバーを作成
非同期 CRUD API の構築 - fastapi-async-crud テンプレートで高パフォーマンスな非同期 API を開発
ドメイン指向プロジェクト (Domain Starter) - 推奨される現代的デフォルトである fastapi-domain-starter テンプレートで中規模 API を構築

🗄️ データベースとインフラ

データベース統合 - fastapi-psql-orm テンプレートで PostgreSQL + SQLAlchemy を活用
Docker でのデプロイ - fastapi-dockerized テンプレートで本番デプロイ環境を構築

⚡ 高度な機能

カスタムレスポンス処理と高度な API 設計 - fastapi-custom-response テンプレートでエンタープライズグレードの API を構築
MCP との統合 - fastapi-mcp テンプレートで AI モデルと連携する API サーバーを作成

各チュートリアルが提供するもの:

✅ 実用的な例 - 実際のプロジェクトでそのまま使えるコード
✅ 段階的なガイド - 初心者でも追えるよう詳しく解説
✅ ベストプラクティス - 業界標準のパターンとセキュリティ上の考慮
✅ 拡張のヒント - プロジェクトを次のレベルへ進めるためのガイダンス

コントリビュート

コミュニティからの貢献を歓迎します! FastAPI-fastkit は Python と FastAPI の入門者を支援するために設計されており、皆さんの貢献は大きな影響を生み出します。

貢献できること

🚀 新しい FastAPI テンプレート - さまざまなユースケース向けのテンプレート追加
🐛 バグ修正 - 安定性と信頼性の向上に協力
📚 ドキュメント - ガイド、サンプル、翻訳の改善
🧪 テスト - テストカバレッジの拡大と統合テストの追加
💡 機能 - 新しい CLI 機能の提案と実装

コントリビュートを始める

FastAPI-fastkit へのコントリビュートを始めるには、次の包括的なガイドを参照してください:

開発環境のセットアップ - 開発環境を整えるための完全ガイド
コードガイドライン - コーディング標準とベストプラクティス
CONTRIBUTING.md - 包括的なコントリビュートガイド
CODE_OF_CONDUCT.md - プロジェクトの原則とコミュニティ基準
SECURITY.md - セキュリティガイドラインと報告手順

FastAPI-fastkit が目指すもの

FastAPI-fastkit は、Python と FastAPI を初めて使う方に対して、速くて使いやすいスターターキットを提供することを目標にしています。

このアイデアは、FastAPI 入門者が最初から段階的に学べるように支援したいという思いから生まれました。これは FastAPI 0.111.0 のバージョンアップで追加された FastAPI-cli パッケージが持つ実践的な意義とも軌を一にしています。

長く FastAPI を愛用してきた者として、FastAPI 開発者 tiangolo が表明した素晴らしい動機を少しでも実現する手助けになるプロジェクトを作りたいと考えました。

FastAPI-fastkit は次の価値を提供することで、「最初の一歩」と「本番運用に耐えるアプリケーション」の間のギャップを埋めようとしています:

即座の生産性 - セットアップの複雑さに圧倒されがちな新規ユーザーに即時の生産性を提供
ベストプラクティス - すべてのテンプレートにベストプラクティスが組み込まれており、利用者が正しい FastAPI のパターンを学べる
拡張可能な土台 - 初心者からエキスパートへ成長するに従って、共に拡張していける土台
コミュニティ駆動のテンプレート - 実世界の FastAPI 利用パターンを反映したコミュニティ中心のテンプレート

次のステップ

FastAPI-fastkit を始める準備ができたら、次の流れで進めてみましょう:

🚀 クイックスタート

インストール: FastAPI-fastkit をインストール
クイックスタート: 5 分で最初のプロジェクトを作成
入門チュートリアル: 段階的な詳細チュートリアル

📚 さらに学ぶ

プロジェクトの作成: さまざまなスタックでプロジェクトを作成
ルートの追加: プロジェクトに API エンドポイントを追加
テンプレートの利用: あらかじめ用意されたプロジェクトテンプレートを活用

🛠️ コントリビュート

FastAPI-fastkit に貢献したいですか?

開発環境のセットアップ: 開発環境を整える
コードガイドライン: コーディング標準とベストプラクティスに従う
コントリビュートガイドライン: 包括的な貢献ガイド

🔍 リファレンス

CLI リファレンス: 全 CLI コマンドのリファレンス
テンプレート品質保証: 自動化されたテストと品質基準
FAQ: よくある質問
GitHub リポジトリ: ソースコードと Issue トラッキング

ライセンス

このプロジェクトは MIT ライセンスのもとで提供されます — 詳細は LICENSE ファイルを参照してください。