FastAPI Template

Шаблон FASTAPI

Описание

Шаблон Fastapi - это шаблон проекта, который обеспечивает хорошую структуру файлов и настройку для создания приложений FastAPI. Он включает в себя предварительную среду разработки, готовые к производству сценарии развертывания и параметры конфигурации SSL. Этот шаблон направлен на то, чтобы разработчикам было легче запустить новые проекты Fastapi с надежным фундаментом и лучшими практиками.

Функции

• Очистить структуру файла для организации вашего приложения FastAPI
• Настройка виртуальной среды для изолированных зависимостей
• Скрипты изготовления производства для развертывания
• Настраиваемая настройка SSL для безопасных соединений
• Предварительно сконфигурированная журнала с журналами, сохраненными в файле
• Интернет -интерфейс для просмотра и поиска журналов со многими параметрами

Установка

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 или стрелобник:

Использование Uvicorn: uvicorn api.main:app --reload --port 8086

Использование стрелков: gunicorn -k uvicorn.workers.UvicornWorker api.main:app

Приложение начнет работать на http: // localhost: 8086.

Развертывание

Для развертывания производства шаблон обеспечивает трубопровод Docker CI и файлы конфигурации docker-compose для легкого развертывания.

Внося

Взносы приветствуются! Если вы хотите внести свой вклад в шаблон FASTAPI, следуйте этим шагам:

1. Вилка репозитория
2. Создайте новую ветку для вашей функции или исправления ошибок
3. Сделайте свои изменения и совершите их
4. Встаньте свои изменения в свою вилку
5. Отправить запрос на привлечение в master филиал оригинального репозитория

Пожалуйста, обязательно следуйте существующему стилю кода и добавьте тесты для любых новых функций или исправлений ошибок.

Лицензия

Шаблон FOSTAPI выпускается по лицензии MIT. Вы можете свободно использовать, изменять и распространять этот шаблон для любых целей.