julianbrendl/html-rust

html-rust

镜像概述和主要用途

html-rust 是一个简单、轻量级的服务器，用于将 Rust 代码转译为 HTML。该项目源于使用 Rust 构建 React 组件的需求，底层基于 https://github.com/bodil/typed-html 库。通过此镜像，用户可以便捷地将符合特定格式的 Rust 代码转换为 HTML 输出。

核心功能和特性

• 轻量级设计：服务器架构简单，资源占用低，部署便捷
• 基于 typed-html：使用成熟的 typed-html 库进行 Rust 到 HTML 的转译，确保转译结果的准确性和兼容性
• API 接口支持：提供清晰的 API 接口，便于集成到各类应用流程中
• 状态检查：内置服务状态检查接口，方便监控服务运行状况

使用场景和适用范围

• 需要通过 Rust 代码生成 HTML 内容的场景
• 构建基于 Rust 的 React 组件开发流程
• 需要在服务端将 Rust 逻辑转换为 HTML 输出的应用
• 轻量级 HTML 生成服务的快速部署需求

API 说明

/transpile

通过 POST 请求调用该接口进行 Rust 代码到 HTML 的转译。请求需包含以下 JSON payload：

json
{
  "code": "需要转译的 Rust 代码"
}

重要：提交的代码必须符合指定格式，需包含 fn render() -> DOMTree<String> 函数，如下例所示：

Rust 代码示例：

rust
fn render() -> DOMTree<String> {
    let code = "HELLO WORLD!";

    return html!(
        <div>{ text!(code) }</div>
    );
}

转译后的 HTML 结果：

html
<div>HELLO WORLD!</div>

/status

通过 GET 请求调用该接口检查服务状态。服务正常运行时，将返回 200 状态码。

Docker 部署说明

该服务器的 Docker 镜像可在 Docker Hub 获取：https://hub.docker.com/r/julianbrendl/html-rust/

基本运行命令

bash
docker run -d -p 8080:8080 julianbrendl/html-rust

验证服务状态

服务启动后，可通过以下命令检查状态：

bash
curl http://localhost:8080/status

若返回 200 状态码，表明服务正常运行。

转译示例

使用 curl 测试转译功能：

bash
curl -X POST http://localhost:8080/transpile \
  -H "Content-Type: application/json" \
  -d '{"code": "fn render() -> DOMTree<String> { html!(<p>Hello from html-rust!</p>) }"}'

预期返回 HTML 结果：

html
<p>Hello from html-rust!</p>