kuzmenkov/plumber

plumber镜像说明

镜像概述

plumber是一款将R语言函数快速转化为Web API的工具，通过在R代码中添加特殊注释，即可将普通函数映射为API端点。该Docker镜像封装了plumber运行环境，方便开发者直接部署基于R的API服务。

核心功能

• 注释驱动API: 使用#*前缀注释R函数，自动生成GET/POST等请求端点
• 多数据格式支持: 兼容查询参数、表单数据、JSON等输入方式
• 轻量部署: 可快速在本地或云端启动API服务
• 灵活参数传递: 自动将请求参数转为R函数的输入参数

使用场景

• 数据科学模型的API化部署（如预测模型、统计分析接口）
• 自动化数据处理任务的远程调用
• R语言工具的Web化封装
• 科研成果的API形式共享

配置说明

1. 编写带注释的R脚本（示例plumber.R）：

r
#* @get /mean
normalMean <- function(samples=10){
  mean(rnorm(as.integer(samples)))
}

#* @post /sum
addTwo <- function(a, b){
  as.numeric(a) + as.numeric(b)
}

2. 运行plumber服务：加载脚本并指定端口启动

Docker部署示例

单容器运行

将本地plumber.R挂载到容器中并启动服务：

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

验证API

使用curl测试端点：

bash
# 测试GET接口
curl "http://localhost:8000/mean?samples=100"
# 测试POST接口（JSON格式）
curl --data '{"a":5, "b":3}' http://localhost:8000/sum

扩展说明

该镜像基于官方R环境构建，可通过修改R脚本扩展API功能，也可结合PM2、DigitalOcean等工具实现高可用部署。更多细节参考plumber官方文档。