start fastapi

Start-Fastapi

Версия 2021, основанная на FASTAPI, простое в использовании веб-приложение, разработанное на Starlette Framework

• Версия 2020
• 中文文档

Требования

• Python 3.6+ (для проверки статического типирования)
• pip3 install -r ./requirements.txt
  • FOSTAPI, UVICORN, Python-Dotenv, Python-Multipart, Webockets и т. Д.
• идея/pycharm (рекомендуется) + venv

Структура

Веб -приложение основано на стиле лука ~

Структура каталога:

• Приложение: логика для вашего приложения, включающая __init__.py в качестве ввода пользовательских модулей
  • Хэндлер: контроллеры
  • промежуточное программное обеспечение: промежуточное программное обеспечение, например, CORS
  • Модель: базовые модели данных и внутренняя логика
  • Сервис: внешняя логика (для пользователей)
• CFG: конфигурация различных ENVS
  • dev: конфигурации Dev Env
    • app.cfg: python-dotenv cfg для fastapi
    • Uvicorn.json: CFG для сервера Uvicorn ASGI, запуска для FastApi
    • logger.json: регистрация CFG для Uvicorn
  • Prod: конфигурации производственной env
• Ядро: библиотеки низкого уровня и логика, включает в себя __init__.py в качестве ввода основных модулей, лучше сделать повторно в других проектах
  • обработчик
  • LIB: API -интерфейсы LIB:
  • модель
  • услуга
    • Транс: Служба транзакций , для управления задачами, работающими на фоне
• Разное: различные детали, такие как сборка, тестовые сценарии и т. Д.
  • Строитель: Строительные сценарии
  • DEV: Ресурсы для использования разработчика
    • gen_code.py: сценарий для генерации кодов
  • Док: Докс
  • Тест: тестовые сценарии
• main.py: Main entry, init uvicorn и запустите приложение Fastapi
• Требования.txt: Требования к пакетам PY

Быстрый старт

Запустить сервер приложений

Запустить ./main.py , чтобы начать пример, который включает в себя:

• Основные модули: обработчик проверки здоровья, базовые модели, служба транзакций
• Промежуточное программное обеспечение CORS настроено с подстановочным знаком *
• Тестовые обработчики, модели и услуги: моделирует простую систему рыночной торговли с продуктами и клиентами
  • Примеры файла WebSocket и загрузки также включены в тестовые обработчики

Внутренние шаги:

• ./main.py загружает конфигурации внутри ./cfg/{env} на cmd args, затем вызывает uvicorn.run , чтобы запустить приложение Fastapi по адресу ./app/__init__.py
• ./app/__init__.py startup

Вы можете поместить свои сценарии запуска внутрь ./misc/build для ваших различных вариантов запуска

Руководство по кодированию

Чтобы построить свою логику, следующие общие шаги следующие:

• ./main.py запускает сервер в среде Dev по умолчанию, в которой включена горячая загрузка
• Добавить обработчики в ./app/handler , добавьте соответствующие коды import & APP.include_router в ./app/__init__.py
• Добавить модели данных в ./app/model , добавить услуги в ./app/service
• Добавьте средние стороны в ./app/middleware если это необходимо

Несколько советов по кодированию:

• Получить /docs для тестирования маршрутизаторов на веб -странице
• Избегайте использования Coroutines ( async def ), так как он может блокировать основной evtloop, чтобы другие запросы не обрабатываются во времени. Функции def будут вызваны в разных потоках
• Коды ./core должны быть общими (для других проектов), коды ./app должны соответствовать текущему проекту
• Вы можете использовать ./misc/dev/gen_code.py для генерации кодов шаблонов для обработчиков, моделей и сервисов. Exec It с рабочим каталогом в качестве каталога Project Root
• Кодовые модели, основанные на pydantic.BaseModel , она мощная

Http -ответ

Большинство обработанных запросов должны содержать код состояния 200

Простое решение - использовать модель Resp в ./core/model/handler.py

 {
  "success": bool,
  "message": str,
  "code": IntEnum,
  "data": Any,
}

Используйте Resp.ok для получения ответа на успех и используйте Resp.err для генерации ответа на ошибку

Разное

WebSocket

Обработчик тестирования ./app/handler/test.py содержит примеры обработчика WS

Чтобы узнать больше об этом, см. Документацию WebSocket

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

Запустите ./misc/build/pack.sh , чтобы упаковать проект в ./misc/build/start-fastapi.tar.gz

См ./misc/build/Dockerfile для примера развертывания Docker