trestletech/plumber

plumber镜像说明

镜像概述

plumber是一款用于R语言的Web API框架，通过简单的注释即可将R函数转化为可访问的API端点，无需复杂的Web开发知识，帮助开发者快速构建基于R的API服务。

核心功能

• 注释驱动: 使用#*或#'注释标记R函数，自动生成API端点
• 多请求方法支持: 支持GET、POST等HTTP请求方法
• 数据格式兼容: 支持JSON、表单数据等多种输入格式
• 多样化输出: 可返回JSON、图片（如直方图）等多种输出类型
• 便捷部署: 支持本地运行、Docker容器化部署及云服务托管

使用场景

1. 数据科学团队将R模型（如预测模型）部署为API供其他系统调用
2. 自动化数据分析任务，通过API触发R脚本执行并返回结果
3. 构建基于R的内部工具或服务，供前端应用调用

配置说明

编写plumber.R文件

创建包含注释标记的R脚本（如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)
}

Docker部署示例

1. 拉取镜像

bash
docker pull docker.xuanyuan.run/trestletech/plumber

2. 运行容器（挂载本地plumber.R文件）

假设本地./my-api目录下有plumber.R文件：

bash
docker run -p 8000:8000 -v $(pwd)/my-api:/api docker.xuanyuan.run/trestletech/plumber /api/plumber.R

3. 访问API

• 回声接口：http://localhost:8000/echo?msg=你好
• 直方图接口：http://localhost:8000/plot
• 求和接口（POST）：使用curl发送请求

  bash
  curl --data "a=5&b=3" http://localhost:8000/sum
  # 或JSON格式
  curl --data '{"a":5, "b":3}' http://localhost:8000/sum