rstudio/plumber

Set plumber options through env

Open

#933 创建于 2023年11月24日

在 GitHub 查看
 (3 评论) (0 反应) (0 负责人)R (1,437 star) (257 fork)batch import
difficulty: intermediateeffort: lowhelp wantedtype: enhancement

描述

User @slodge proposed to set plumber options through env variable.

Read an option value, if null, check for an ENV variable?

This would allow some of the API behaviors to change without redeploying code. I can see this to be useful in at least a couple scenario like activating debug with redeploying, changing secret.

Current user probably have some kind of options setting mechanism in place within their API, but it would be pretty "dope" to have it available before you know you need it.

I think this should be extended to all plumber options with a proper naming scheme like "PLUMBER_XXX_", replacing the dot in the option name with an underscore and having all caps?

贡献者指南

技术栈
r
领域
backendapi
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
needs investigation
前置要求
Basic knowledge of RFamiliarity with plumber package
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
45
研究方向
Explore plumber's option system: how options are currently set (likely via `options()` or a config file). Implement a fallback mechanism that reads an environment variable when an option is NULL. Use a naming scheme like `PLUMBER OPTION NAME` where dots are replaced with underscores (e.g., `plumber.debug` becomes `PLUMBER DEBUG`). Check the plumber source code for the list of options and consider consistency across all options. Review any user comments for additional requirements.