rplumberdocker/plumber

Plumber镜像说明

镜像概述

Plumber是一款用于R语言的Web API开发工具，本镜像提供了Plumber的运行环境，允许用户通过简单的注释将R函数转化为可访问的API端点，快速构建数据服务或功能接口。

核心功能

1. 注释驱动API生成：使用#*注释标记R函数，自动生成GET/POST等HTTP接口
2. 多数据格式支持：处理JSON、表单数据等输入，返回JSON或可视化结果（如直方图）
3. 轻量级部署：支持本地运行及Docker、云服务器等多种部署方式
4. 灵活参数传递：将HTTP请求参数映射为R函数参数，简化数据交互

使用场景

• 数据科学团队快速暴露R模型或分析函数为API服务
• 开发基于R的内部工具接口
• 原型验证：快速将R代码转化为可测试的Web服务

配置说明

1. 编写API定义文件：创建plumber.R文件，用注释定义API端点（示例如下）：

r
# plumber.R
#* 回声测试
#* @param msg 输入消息
#* @get /echo
function(msg=""){
  list(msg = paste0("收到消息：'", msg, "'"))
}

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

2. 运行服务：通过Docker启动镜像，映射端口并挂载本地目录

Docker部署示例

单容器运行

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

访问API

• 回声接口：http://localhost:8000/echo?msg=hello
• 直方图接口：http://localhost:8000/plot

安装与扩展

镜像已预装Plumber包，若需更新或安装开发版，可在容器内执行：

r
# 稳定版
install.packages("plumber")
# 开发版（需devtools）
devtools::install_github("trestletech/plumber")