티스토리 뷰

iOS/iOS-Memo

APIKey를 숨겨보자!

malrang-malrang 2022. 10. 9. 20:50

APIKey를 Github에 노출되지 않도록 해야한다!
혹시나 노출되어 법적문제가 발생할수도 있다는...말을 어디선가 들었다..! APIKey 소중하니까 숨겨보도록하자..!

APIKEY 숨기는법

1. PropertyList

먼저 PropertyList 파일을 하나 생성해준다!

파일명은 현재 사용하고 있는 API이름을 따서
MalrangMarketInfo 라고 만들어둡니다!

파일에 API_KEY라는 이름의 Key를 하나 추가합니다!
VendorId와 Secret은 무시해주세요!
Value에는 사용할 APIKEY값을 입력해주면 됩니다!

2. Bundle Extension

PropertyList 파일 작업이 끝나고나면 이제 .swift 파일을 하나 만들어줍니다!

네이밍은 Bundle+Sugar 라고 작성해 두었습니다!

그러고 나서 Plist에 작성한 API_KEY정보를 불러와 사용할 수 있는 코드를 작성해봅시다!
guard 문을 통해 API_KEY를 작성하지 않을 경우 fatalError를 보여주도록 해두었습니다!

그럼이제 API호출할때 APIKey가 필요할때는 아래와 같이 호출하여 대입해줄수 있다!
Bundle.main.apiKey 요녀석이 Plist에 저장한 APIKey 되시겠다.

3. .gitignore 추가하여 추적해제 하기

위의 2번까지 진행후 push를 하게될경우 깃허브에 이력이 남게된다. (MalrangMarketInfo.plist를 추적하고 수정 되었다는 것을 git이 알게된다)

깃허브에 수정이력을 남기지 않고 추적하지 않게 하기위해서는 .gitignore에 해당 파일명을 추가해주면 된다!

프로젝트가 저장된 폴더에 숨김파일로 되어있는 .gitignore 파일을 열어 다음과 같이 작성후 저장해주면 된다!

위의 이미지에서 ## Api_KEY라고 작성된 것을 볼수 있는데 ##은 주석을 의미한다! 알아보기 쉽게 주석과 같이 작성해주자!
주석 아래에는 추적하지 않기를 원하는 파일명! 여기서는 MalrangMarketInfo.plist 를 작성해주었다!

요렇게 저장해주면 MalrangMarket.plist파일 추적하지 않게 되고 add, commit, push하면 깃에 올라가지 않는것을 확인 할 수 있다.

'iOS > iOS-Memo' 카테고리의 다른 글

애플 로그인 구현하기 (Sign in with Apple)  (0) 2022.11.16
Launch Screen을 적용해보자!  (0) 2022.10.10
Cache, NSCache, URLCache  (1) 2022.09.30
Underline SegmanetControl  (0) 2022.08.12
NotificationCenter, Modal 사용시 주의점!  (0) 2022.04.29
공지사항
최근에 올라온 글
최근에 달린 댓글
Total
Today
Yesterday
링크
«   2024/06   »
1
2 3 4 5 6 7 8
9 10 11 12 13 14 15
16 17 18 19 20 21 22
23 24 25 26 27 28 29
30
글 보관함