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许可发布。您可以免费使用，修改和分发此模板出于任何目的。