使用个人密钥的GitHub项目的最佳实践

Question

我正在建立一个使用Goodreads API的项目 - 这意味着使用个人API密钥。

我希望没有（在RMD文档的原始脚本上），但我希望所有代码都是自包含的。

这样做的最佳做法是什么？

目前，我无法想到一种拥有自包含代码的方法，并且无法在原始版本中查看API密钥。

Answer 1

关于Bill the Lizard的评论，你基本上想要这样做：

创建一个新的R文件并将密钥放入其中，将其命名为config.R

##### config.R
Sys.setenv(GOODREADS_KEY = "YOUR_KEY_HERE")
##### end config.R

然后在主代码中运行配置文件：

source("/path/config.R")

在您的Git存储库中，您可以上传config.R的虚拟副本，但请确保不包含实际密钥，因此您可以在公共版本中保留“您的密钥”。

您不应该让其他人使用您的私钥进行API调用。