zalari/plumber

zalari/plumber镜像说明

镜像概述

该镜像基于Plumber工具，允许用户通过在R代码中添加特殊注释，无需复杂Web开发即可将R函数转换为可访问的Web API。适用于数据科学团队快速部署R模型、自动化分析任务或构建交互式数据接口。

核心功能

1. 注释驱动API定义：使用#*注释标记函数为API端点，支持@get/@post等HTTP方法。
2. 多格式支持：自动处理JSON、表单数据输入，返回JSON或图片（如@png生成图表）。
3. 轻量部署：兼容Docker、PM2等部署方式，可快速在本地或云服务器运行。

使用场景

• 数据科学：将R预测模型部署为API供业务系统调用。
• 自动化分析：通过API触发R脚本执行并返回结果。
• 可视化接口：生成动态图表（如直方图）的API服务。

配置说明

1. 编写Plumber脚本

创建plumber.R文件（示例）：

r
#* 回显输入消息
#* @param msg 要回显的消息
#* @get /echo
function(msg="") {
  list(msg = paste0("收到消息：'", msg, "'"))
}

#* 生成直方图
#* @png
#* @get /plot
function() {
  rand <- rnorm(100)
  hist(rand)
}

#* 计算两数之和
#* @param a 第一个加数
#* @param b 第二个加数
#* @post /sum
function(a, b) {
  as.numeric(a) + as.numeric(b)
}

2. Docker部署示例

单容器运行

挂载本地脚本并启动服务：

bash
docker run -d -p 8000:8000 \
  -v $(pwd)/plumber.R:/app/plumber.R \
  zalari/plumber \
  R -e "library(plumber); plumb('/app/plumber.R')\$run(port=8000, host='0.0.0.0')"

Docker Compose示例

创建docker-compose.yml：

yaml
version: '3'
services:
  plumber-api:
    image: zalari/plumber
    ports: ["8000:8000"]
    volumes: ["./plumber.R:/app/plumber.R"]
    command: R -e "library(plumber); plumb('/app/plumber.R')\$run(port=8000, host='0.0.0.0')"

启动：docker-compose up -d

3. 访问API

• 浏览器：http://localhost:8000/echo?msg=测试 或 http://localhost:8000/plot
• Curl：

  bash
  curl "http://localhost:8000/echo?msg=你好"
  curl --data "a=5&b=3" "http://localhost:8000/sum"
  curl --data '{"a":4,"b":6}' -H "Content-Type: application/json" "http://localhost:8000/sum"