NewsAPI 와 같이
API 를 사용하기 위해서는 API Key 를 발급받게 된다.
프로젝트를 진행하면서 Github 과 같은 공개된 공간에
API Key 를 그대로 올리게 되면
사용자들이 API 와 Key 를 확인할 수 있다는 위험이 있다.
API Key 를 노출시키지 않고 Github 에 올리는 방법을 정리해보고자 한다.
첫번째,
API Key 를 저장할 파일(.swift)을 프로젝트 내부에 만든다.
파일의 이름은 자유롭게 정하면 된다.
( 이후에 .gitignore 에 추가할 수 있도록 기억하도록 한다. )
두번째,
파일을 다음과 같이 작성한다.
파일의 이름과 마찬가지로 구조체의 이름 또한 자유롭게 정하면 된다.
( API Key 가 들어갈 곳에 맞게 적절한 이름으로 지정하면 된다. )
import Foundation
struct Storage {
let apiKey = ""
}
세번째,
기존의 API Key 를 넣었던 자리에
두번째에서 작성한 구조체.apiKey
를 넣어주면 된다.
let url = URL(string: Storage().apiKey)!
네번째,
프로젝트의 최상위 경로로 이동하여 .gitignore
을 생성하여
첫번째에서 생성하였던 파일의 이름을 내부에 작성해준다.
vi
나 vim
을 이용해도 되고, touch
커맨드를 이용해서 생성해주어도 된다.
( vi
나 vim
을 이용한다면 바로 글을 작성할 수 있다.)
$ vi .gitignore
$ vim .gitignore
$ touch .gitignore # .gitignore 생성
$ open .gitignore # .gitignore 열기
마지막으로,
기존에 github 을 이용하던 방식대로 git status
로 상태를 확인해주고
git add
, git commit
, git push
등을 하여
github repository 에 올려주면 된다.
📚 Reference
[Git/iOS/Xcode] API Key 숨기기