RPlumber API - 将数据作为 CSV 而不是 JSON 返回 - 在 mac 上本地工作,但不在 ubuntu-16.04 上工作
RPlumber API - returning data as CSV instead of JSON - works locally on mac, but not on ubuntu-16.04
我们正在使用 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,2,3), b = c(3,4,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
returns 是 JSON 格式的数据,而 test-endpoint-1
returns 是 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, path, expiration = FALSE, http = FALSE,
setHeader: function (name, value)
status: 200
toResponse: function ()
[1] "\"a\",\"b\"\n1,3\n2,4\n3,5"
这些是正确的打印语句 - 与我们在本地获得的相同。出于某种原因,服务器不允许我们以 CSV 格式 return 与我的本地 machine 允许的方式相同,我不知道为什么会这样,也不知道如何解决它。
编辑
更新本地 machine 上的 plumber
库后,我现在也在本地 machine 上收到错误 An exception occurred.
。看来,在较新版本的管道工中,我用来将 API 端点输出转换为 CSV 文件的代码片段:
...
con <- textConnection("val","w")
write.csv(x = mydata, con, row.names = FALSE)
close(con)
res$body <- paste(val, collapse="\n")
return(res)
不再有效。
编辑 2
这是我近 3 年前的 关于如何 return 将数据作为 CSV 格式...似乎不再有效的方法。
编辑 3
使用@serialize csv 确实“有效”,但是当我到达终点时,数据以 CSV 格式下载到我的本地 machine,而数据最好只是 return从 API 以 CSV 格式编辑,但未自动下载到 CSV 文件中...
也许可以从中寻找灵感,在这里我将回复 content-type headers 修改为 text/plain。 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 (remotes::install_github("rstudio/httpuv")
) 安装 httpuv
和 运行 再次 API 应该可以解决问题。
我们正在使用 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,2,3), b = c(3,4,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
returns 是 JSON 格式的数据,而 test-endpoint-1
returns 是 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, path, expiration = FALSE, http = FALSE,
setHeader: function (name, value)
status: 200
toResponse: function ()
[1] "\"a\",\"b\"\n1,3\n2,4\n3,5"
这些是正确的打印语句 - 与我们在本地获得的相同。出于某种原因,服务器不允许我们以 CSV 格式 return 与我的本地 machine 允许的方式相同,我不知道为什么会这样,也不知道如何解决它。
编辑
更新本地 machine 上的 plumber
库后,我现在也在本地 machine 上收到错误 An exception occurred.
。看来,在较新版本的管道工中,我用来将 API 端点输出转换为 CSV 文件的代码片段:
...
con <- textConnection("val","w")
write.csv(x = mydata, con, row.names = FALSE)
close(con)
res$body <- paste(val, collapse="\n")
return(res)
不再有效。
编辑 2
这是我近 3 年前的
编辑 3
使用@serialize csv 确实“有效”,但是当我到达终点时,数据以 CSV 格式下载到我的本地 machine,而数据最好只是 return从 API 以 CSV 格式编辑,但未自动下载到 CSV 文件中...
也许可以从中寻找灵感,在这里我将回复 content-type headers 修改为 text/plain。 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 (remotes::install_github("rstudio/httpuv")
) 安装 httpuv
和 运行 再次 API 应该可以解决问题。