FastHX:FastAPI 服务器端渲染工具
fasthx FastAPI and HTMX, the right way. 项目地址: https://gitcode.com/gh_mirrors/fa/fasthx
1. 项目介绍
FastHX 是一个为 FastAPI 设计的服务器端渲染工具,它支持内置的 HTMX 支持。FastHX 允许开发者以声明性的装饰器方式处理 FastAPI 路由的渲染/展示层,同时保留路由处理业务逻辑的能力。它适用于任何模板引擎或服务器端渲染库,如 htmy、jinja2 或 dominate。
2. 项目快速启动
首先,确保你已经安装了 FastAPI 和 pip。然后,按照以下步骤进行快速启动:
# 安装 FastHX
pip install fasthx
# 安装 FastHX 的 htmy 集成(可选)
pip install fasthx[htmy]
# 或者安装 FastHX 的 jinja 集成(可选)
pip install fasthx[jinja]
创建一个 FastAPI 应用并使用 FastHX:
from fastapi import FastAPI
from fasthx import HTMY
# 创建 FastAPI 应用
app = FastAPI()
# 创建 FastHX HTMY 实例
htmy = HTMY()
# 使用 HTMY 装饰器创建路由
@app.get("/users")
@htmy.hx(UserList)
def get_users():
# 返回用户数据
return [
User(name="John", birthday=date(1940, 10, 9)),
User(name="Paul", birthday=date(1942, 6, 18)),
User(name="George", birthday=date(1943, 2, 25)),
User(name="Ringo", birthday=date(1940, 7, 7)),
]
@app.get("/")
@htmy.page(IndexPage)
def index():
# 渲染首页
pass
运行你的 FastAPI 应用。
3. 应用案例和最佳实践
以下是使用 FastHX 的一些应用案例和最佳实践:
- 使用装饰器语法:FastHX 的装饰器与 FastAPI 的工作方式一致,无需额外的或神秘的依赖。
- 支持同步和异步路由:无论你的路由是同步还是异步,FastHX 都能正常工作。
- 保留响应头:在路由中设置的响应头在渲染后仍然会被保留。
4. 典型生态项目
FastHX 可以与多个模板引擎集成,以下是一些典型的生态项目:
- htmy:一个基于组件的模板引擎,可以与 FastHX 配合使用,通过 pip 安装
fasthx[htmy]
。 - jinja2:一个流行的模板引擎,可以与 FastHX 配合使用,通过 pip 安装
fasthx[jinja]
。
通过使用这些集成,开发者可以更容易地创建复杂的服务器端渲染应用。
fasthx FastAPI and HTMX, the right way. 项目地址: https://gitcode.com/gh_mirrors/fa/fasthx
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考