GitHubにあげる際に.gitignoreを使用してAPIキーを非表示にしよう！

.gitignoreとは

Gitにアップロードする際に、除外したいファイルを記載するファイルのこと。差分に出てきて欲しくないファイルを、.gitignoreに記述することで除外することができます！

.gitignoreファイルの作り方

①ターミナルで、.gitignoreファイルを作成したいプロジェクトに移動。

cd プロジェクトのパス

②.gitignoreファイルを作成

touch .gitignore

③.gitignoreファイルを開く

open .gitignore

④.gitignoreに記載
このファイルにこのようにパスを記載すると、Gitのアップロード対象から除外できます。

例：このような[APIKey]を記載したファイルを作成し、.gitignoreに記載して隠しました。

struct Constants {
    static let apiKey = [APIKey]
}

呼び出し元でもAPIKeyを隠すことができます！

let urlString = "https://api.openweathermap.org/data/2.5/weather?lat=\(latitude)&lon=\(longitude)&appid=\(Constants.apiKey)"

実際にGitHubに上げてクローンしてみると、Constants.swiftファイルが赤になっており、アップロード対象から除外できます。

検討

以前書いた下記の記事のように環境変数でAPIキーを非表示にする方法をあげました。

環境変数を使用する問題点：GitHub上でPublicで公開した場合、クローンしても同じAPIKeyが使用できてしまう！Edit SchemeからAPIKeyが見えてしまうという問題があります。
そのため、PublicでGitHubに公開するには、今回紹介した.gitignoreを使用してAPIキーを非表示にする方法の方が有効です！
環境変数を使用するメリット：環境変数でAPIキーを非表示にする方法は、チームでGitHub上で開発する際や、開発用APIのURLと本番用APIのURLを分けて使用したい際に有効です！

参考文献