问题描述
我们正在使用RPlumber托管API,我们的开发人员要求API端点以CSV格式而不是JSON格式提供数据。为了解决这个问题,我们需要执行以下操作:
r_endpoints.R
#* @get /test-endpoint-1
testEndpoint <- function(res) {
mydata <- data.frame(a = c(1,2,3),b = c(3,4,5))
print('mydata')
print(mydata)
con <- textConnection("val","w")
print(paste0('con: ',con))
write.csv(x = mydata,con,row.names = FALSE)
close(con)
print('res and res.body')
print(res);
res$body <- paste(val,collapse="\n")
print(res$body)
return(res)
}
#* @get /test-endpoint-2
testEndpoint2 <- function() {
mydata <- data.frame(a = c(1,5))
return(mydata)
}
run_api.r
library(plumber)
pr <- plumber::plumb("r_endpoints.R")
pr$run(host = "0.0.0.0",port = 8004)
test-endpoint-2
返回JSON格式的数据,而test-endpoint-1
返回CSV格式的数据。当这些端点在Mac上本地运行时,当我命中端点时,会收到以下正确输出:
要托管API,我们已在Linode Ubuntu 16.04服务器上安装了R +库+ pm2,并安装了所有(我认为全部)依赖项。当我们尝试访问服务器上托管的端点时,会收到:
以下是我添加到test-endpoint-1
中以帮助调试的打印语句:
[1] "mydata"
a b
1 1 3
2 2 4
3 3 5
[1] "con: 3"
[1] "res and res.body"
<PlumberResponse>
Public:
body: NULL
clone: function (deep = FALSE)
headers: list
initialize: function (serializer = serializer_json())
removeCookie: function (name,path,http = FALSE,secure = FALSE,same_site = FALSE,serializer: function (val,req,res,errorHandler)
setCookie: function (name,value,expiration = FALSE,setHeader: function (name,value)
status: 200
toResponse: function ()
[1] "\"a\",\"b\"\n1,3\n2,4\n3,5"
这些是正确的打印语句-与我们在本地获得的相同。由于某些原因,服务器不允许我们以本地计算机所允许的相同方式以CSV格式返回,而且我不知道为什么会出现这种情况或如何解决。
编辑
在更新本地计算机上的plumber
库之后,现在我也在本地计算机上收到错误An exception occurred.
。在较新版本的plumber中,似乎我用来将API端点输出转换为CSV文件的代码片段:
...
con <- textConnection("val","w")
write.csv(x = mydata,row.names = FALSE)
close(con)
res$body <- paste(val,collapse="\n")
return(res)
不再有效。
编辑2
这是我自己的stackoverflow post,这是将近3年前的关于如何以CSV格式返回数据的信息……似乎不再起作用。
编辑3
使用@serialize csv可以“工作”,但是当我点击端点时,数据将以CSV格式下载到我的本地计算机上,而最好以API的CSV格式返回数据,但不会自动下载到CSV文件中...
解决方法
也许可以从中寻找灵感,在这里我将响应内容类型的标题修改为text / plain。文字/纯文字应该显示在我认为的浏览器中。
#* @get /json
#* @serializer unboxedJSON
function() {
dostuff()
}
#* @get /csv
#* @serializer csv list(type="text/plain; charset=UTF-8")
function() {
dostuff()
}
dostuff <- function() {
mtcars
}
,
此丑陋的代码有效
编辑:为swagger UI添加了枚举规范
library(plumber)
#* @get /iris
function(type,res) {
if (type == "csv") {
res$serializer <- serializer_csv(type = "text/plain; charset=UTF-8")
}
iris
}
#* @plumber
function(pr) {
pr_set_api_spec(pr,function(spec) {
spec$paths$`/iris`$get$parameters[[1]]$schema$enum = c("json","csv")
spec
})
}
,
An exception occurred
问题实际上来自于 httpuv
,并已在最新的 GitHub 版本的软件包中修复(请参阅 https://github.com/rstudio/httpuv/pull/289)。从 GitHub (httpuv
) 安装 remotes::install_github("rstudio/httpuv")
并再次运行 API 应该可以解决问题。