[iOS] .xcconfig 파일을 활용한 API Key 숨기기

Zerom·2024년 4월 18일
1

iOS 정리

목록 보기
2/6
post-thumbnail

API를 활용해서 이커머스 데모앱을 하나 만드려고 정말 많이 찾아보다가 알라딘 Open API를 발견했는데 괜찮아서 BookDemoApp을 만들기로 했다.

알라딘 OpenAPI
해당 페이지에서 가입을 하게 되면 API Key를 발급받을 수 있는데 API Key가 다른 사람에게 노출될 경우 위험할 수 있기 때문에 숨기는 방법에 대해서 찾아보며 적용했고, 포스팅을 통해 기록하려 한다.

.xcconfig 파일 활용

  1. 우선 XCode에서 프로젝트의 최상단에 Command + N을 눌러 새 .xcconfig 파일을 만들어 준다. (검색은 config로 해야 나온다)

  2. 생성된 .xcconfig 파일에 APIKey = 발급받은 API키를 넣어준다.

  3. 다음 TARGETS에서 Info로 들어가 APIKey를 추가해주고 Value에 $(APIKey)를 작성해준다.

  4. PROJECT의 Info에서 Debug에서 Config를 선택해준다. 만약 출시도 할 예정이라면 Release에서도 선택해준다.

  5. 앱에 Network폴더에서 Const.swift 파일을 생성해주고 아래와 같이 번들에 접근해서 키를 가져오도록 한다. (폴더나 Const 파일명은 자유이고 이렇게 선언해서 사용하지 않아도 상관없긴 하다. 번들에 접근해서 키를 가져오는 방법만 알면 된다.)

이렇게하면 이제 어디서든 APIKey를 불러서 사용할 수 있다.

.gitignore에 추가해서 Github push 방지

  1. 해당 프로젝트에서 터미널을 연 다음 vi .gitignore을 입력해 vi편집기로 들어간다.

  2. vi 편집기에서 i를 눌러 INSERT모드로 만든 다음 *.xcconfig를 입력하고 esc를 눌러 INSERT모드를 나온 후 :qw를 입력해 파일을 저장하고 vi 모드에서 빠져나온다.

  3. git add .gitignore 부터 시작해서 커밋을 해준 후 나머지 프로젝트 파일도 add하고 커밋하고 푸시해준다.

  • 만약 위와 같이 했는데 ignore이 안되고 .xcconfig 파일이 github에 올라간다면
    git rm -r --cached .를 터미널에 입력해 캐시를 삭제하고 다시 전체를 에드부터 푸시까지 해주면 된다.
profile
꼼꼼한 iOS 개발자 /
Apple Developer Academy @ POSTECH 2기 / 멋쟁이사자처럼 앱스쿨 1기

0개의 댓글