如何在R的Plumber中修改Swagger默认访问路径?
修改Plumber Swagger文档访问路径的可行方法
要将Swagger文档路径改为http://127.0.0.1:8000/r-api/__docs__/,核心是给整个API设置基础路径前缀,Plumber提供两种可靠实现方式:
方法一:代码层面设置基础路径
使用pr_set_basepath()函数为Plumber对象添加基础路径前缀,Swagger文档路径会自动继承该前缀:
library(plumber) # 加载你的Plumber路由文件(示例为plumber.R) pr <- plumb("plumber.R") # 设置API基础路径为/r-api pr <- pr_set_basepath(pr, "/r-api") # 启动服务 pr_run(pr, port = 8000)
服务启动后,直接访问http://127.0.0.1:8000/r-api/__docs__/即可打开Swagger文档。
方法二:配置文件方式设置
在项目根目录创建_plumber.yml配置文件,写入基础路径配置:
basePath: "/r-api"
之后正常加载并启动Plumber服务,配置会自动生效:
library(plumber) pr <- plumb("plumber.R") pr_run(pr, port = 8000)
关于之前的错误说明
plumber::options_plumber()中不存在apiPath参数,因此调用该方法会触发错误。设置API前缀的正确方式是上述两种,而非修改全局选项。
内容的提问来源于stack exchange,提问作者Kiran
相关产品推荐
相关产品推荐

