如何在 GitHub 仓库中隐藏 API KEY

如何在 GitHub 仓库中隐藏 API 密钥

如果您要在 GitHub 上推送本地代码，那么隐藏敏感数据是一种最佳做法API KEY，请按照本指南删除敏感信息。

• 在终端中，创建一个config.js文件并打开它：

Code config.js

• 在配置文件中，像这样将你的 API 密钥输入到一个对象中（你可以随意命名，并将密钥作为字符串传入）。你不需要在这个文件中添加任何其他代码：

var config = {
  MY_API_TOKEN : '12345',
  SECRET_API_KEY : '56789',
}

• 在您的 HTML 文件中，在您的 javascript 下方但在您自己的脚本文件链接上方添加指向此文件的脚本链接：

<script type='text/javascript' src='config.js'></script>

• 在你的 JavaScript 文件（可能是script.js）中，像这样声明指向API keys配置文件的变量。注意，config这里的 指的是名为 config 的对象，而不是文件config.js：

var token = config.MY_API_TOKEN;
var key = config.SECRET_API_KEY;

• 请务必用这些新变量替换所有 API 密钥实例。
  例如，之前的代码是：
  url:，'https://www.your-api-host.com/?query&token=12345&key=56789'
  现在的代码是：
  url:'https://www.your-api-host.com/?query&id=' + token + '&pass=' + key

• 在终端中创建一个 .gitignore 文件，并在 Atom 中打开。注意文件名开头的句点：
  

Code .gitignore

• 在该文件中.gitignore，输入任何你不想让 git 执行track/ commit/操作的文件名push。无需其他代码。在本例中，你可以输入：

config.js

• 输入 git st。你应该会看到一个.gitignore可以跟踪的文件。但你不应该看到这个config.js文件。

• git add .，然后再次执行 git st。确保该config.js文件未被添加。如果一切正常，就可以
  提交并推送了。