julianbrendl/html-scala

html-scala

镜像概述和主要用途

html-scala是一个简单、轻量级的服务器，用于将Scala代码转换为HTML。该项目源于使用Scala构建React组件的需求，底层基于https://github.com/lihaoyi/scalatags%E5%BA%93%E3%80%82%E9%80%9A%E8%BF%87%E6%AD%A4%E9%95%9C%E5%83%8F%EF%BC%8C%E7%94%A8%E6%88%B7%E5%8F%AF%E5%B0%86%E7%AC%A6%E5%90%88%E7%89%B9%E5%AE%9A%E6%A0%BC%E5%BC%8F%E7%9A%84Scala%E4%BB%A3%E7%A0%81%E8%BD%AC%E6%8D%A2%E4%B8%BA%E5%AF%B9%E5%BA%94%E7%9A%84HTML%E8%BE%93%E5%87%BA%EF%BC%8C%E5%85%B7%E4%BD%93%E8%BD%AC%E6%8D%A2%E8%A7%84%E5%88%99%E5%8F%AF%E5%8F%82%E8%80%83scalatags%E6%96%87%E6%A1%A3%E3%80%82

核心功能和特性

• 轻量级设计：服务器资源占用低，部署简单
• Scala到HTML转换：基于scalatags实现Scala代码到HTML的转换
• API接口：提供HTTP接口，支持代码转换和服务状态检查
• React组件支持：专为构建React组件设计的代码转换逻辑

使用场景和适用范围

• 使用Scala语言开发React组件的场景
• 需要将Scala代码动态转换为HTML的应用集成
• 开发环境中快速验证Scala代码生成HTML的效果

详细使用方法和配置说明

API接口说明

/transpile

通过POST请求将Scala代码转换为HTML。请求需包含JSON格式的payload：

json
{
  "code": "需要转换的Scala代码"
}

重要：代码必须按照示例格式编写，使用ReactComponent类。

/status

通过GET请求检查服务状态。服务正常时返回200状态码。

使用示例

Scala代码示例

scala
new ReactComponent {
  def messageOfTheDay() = "Hello World!"
  
  override def render(): Text.TypedTag[String] = {
    div(
      h1("Amazing Title"),
      div(
       p("Message of the day: " + messageOfTheDay()),
       p("This is the first paragraph."),
       p("This is the second paragraph.")
      )
    )
  }
}

生成的HTML结果

html
<div>
  <h1>Amazing Title</h1>
  <div>
    <p>Message of the day: Hello World!</p>
    <p>This is the first paragraph.</p>
    <p>This is the second paragraph.</p>
  </div>
</div>

Docker部署

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

基本运行命令

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

验证服务状态

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

bash
curl http://localhost:8080/status

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

发送转换请求示例

使用curl发送POST请求进行代码转换：

bash
curl -X POST http://localhost:8080/transpile \
  -H "Content-Type: application/json" \
  -d '{"code": "new ReactComponent { override def render(): Text.TypedTag[String] = div(p(\"Hello from html-scala\")) }"}'