FastAPI Template

FastAPI模板

描述

FastAPI模板是一個項目模板，可為構建FastAPI應用程序提供良好的文件結構和設置。它包括預先配置的開發環境，可生產的部署腳本和SSL配置選項。該模板旨在使開發人員更容易以強大的基礎和最佳實踐來啟動新的FastAPI項目。

特徵

• 清潔文件結構用於組織您的FastAPI應用程序
• 孤立依賴性的虛擬環境設置
• 準備部署的生產狂歡腳本
• 安全連接的可配置SSL設置
• 預先配置的日誌記錄，將日誌保存到文件
• Web UI用於查看和搜索日誌，並具有許多選項

安裝

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許可發布。您可以免費使用，修改和分發此模板出於任何目的。