FastAPI Template

Fastapiテンプレート

説明

FastAPIテンプレートは、FASTAPIアプリケーションを構築するための優れたファイル構造とセットアップを提供するプロジェクトテンプレートです。これには、事前に構成された開発環境、生産対応の展開スクリプト、およびSSL構成オプションが含まれています。このテンプレートは、開発者が堅牢な基盤とベストプラクティスを念頭に置いて新しいFastAPIプロジェクトを簡単に開始できるようにすることを目的としています。

特徴

• FastAPIアプリケーションを整理するためのファイル構造をきれいにします
• 孤立した依存関係の仮想環境セットアップ
• 展開用の制作対応バッシュスクリプト
• 安全な接続用の構成可能なSSLセットアップ
• ファイルに保存されたログを使用した事前に構成されたロギング
• 多くのオプションでログを表示および検索するためのWebUI

インストール

1. リポジトリをクローンします：

git clone https://github.com/Neko-Nik/FastAPI-Template.git
cd FastAPI-Template

2. 仮想環境を作成してアクティブ化します。

python3 -m venv virtualenv
source virtualenv/bin/activate

3. 必要な依存関係をインストールします。

pip3 install -r requirements.txt

使用法

UvicornまたはGunicornを使用して、アプリケーションをローカルに実行するには：

uvicornの使用： uvicorn api.main:app --reload --port 8086

Gunicornの使用： gunicorn -k uvicorn.workers.UvicornWorker api.main:app

アプリケーションはhttp：// localhost：8086で実行を開始します。

展開

生産展開のために、テンプレートはDocker CIパイプラインとdocker-compose構成ファイルを提供して、簡単に展開します。

貢献

貢献は大歓迎です！ Fastapiテンプレートに貢献したい場合は、次の手順に従ってください。

1. リポジトリをフォークします
2. 機能またはバグ修正のための新しいブランチを作成する
3. 変更を加えてコミットしてください
4. 変更をフォークに押し込みます
5. 元のリポジトリのmasterブランチにプルリクエストを送信する

既存のコードスタイルに従って、新しい機能やバグ修正のテストを追加してください。

ライセンス

Fastapiテンプレートは、MITライセンスの下でリリースされます。このテンプレートは、あらゆる目的で自由に使用、変更、配布できます。