首页
/ FastHX 使用教程

FastHX 使用教程

2025-04-18 22:08:52作者:裴麒琰

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 应用,并使用 FastHXJinja 实例:

    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 进行用户认证。
  • 使用 pytestpytest-fastapi 进行测试。

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

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
144
1.93 K
kernelkernel
deepin linux kernel
C
22
6
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
274
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
930
553
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
423
392
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
64
511