FastHX 使用教程

1. 项目介绍

FastHX 是一个为 FastAPI 提供服务端渲染的库，它支持与 HTMX 框架的无缝集成，同时也支持其他模板引擎如 jinja2 或 dominate。FastHX 通过装饰器语法简化了 FastAPI 路由的 HTML 响应渲染过程，允许开发者专注于业务逻辑，而将渲染层的处理交给 FastHX。

2. 项目快速启动

首先，确保你已经安装了 Python 环境。然后，通过以下命令安装 FastHX：

pip install fasthx

若你需要使用 HTMX 集成，请安装：

pip install fasthx[htmy]

以下是一个简单的 FastAPI 应用，使用 FastHX 进行服务端渲染的示例：

from fastapi import FastAPI
from pydantic import BaseModel
from fasthx import HTMY

# 定义数据模型
class User(BaseModel):
    name: str
    birthday: date

# 创建 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)),
    ]

# 运行应用
if __name__ == "__main__":
    import uvicorn
    uvicorn.run(app, host="0.0.0.0", port=8000)

确保你的 FastAPI 应用运行在本地开发服务器上，然后访问 http://localhost:8000/users，你应该能看到渲染后的用户列表。

3. 应用案例和最佳实践

使用 jinja2 模板引擎

如果你偏好使用 jinja2，你可以按照以下步骤集成：

1. 安装 FastHX 和 jinja2：

   pip install fasthx[jinja]
   

2. 创建一个 FastAPI 应用，并使用 FastHX 的 Jinja 实例：

   from fastapi import FastAPI
   from fastapi.templating import Jinja2Templates
   from fasthx import Jinja
   
   app = FastAPI()
   jinja = Jinja(Jinja2Templates(directory="templates"))
   

3. 在 templates 目录下创建你的 HTML 模板文件。

4. 使用 Jinja 实例的装饰器来创建路由：

   @app.get("/")
   @jinja.page("index.html")
   def index():
       return {"message": "Hello, World!"}
   

错误处理

FastHX 允许你定义错误处理的组件，当路由中抛出异常时，可以捕获并渲染特定的错误页面。

4. 典型生态项目

FastHX 作为一个 FastAPI 的渲染工具，可以与 FastAPI 生态中的其他项目配合使用，例如：

• 使用 sqlalchemy 进行数据持久化。
• 使用 passlib 进行用户认证。
• 使用 pytest 和 pytest-fastapi 进行测试。

以上是 FastHX 的基础使用教程，你可以根据具体的项目需求，扩展和定制 FastHX 的使用方式。