AWS API Gateway Custom domain 설정

 

API Gateway 배포 후 주소는 다음과 같은 형식으로 생성됩니다.

[api-id].excute-api.[region].amazonaws.com/[stage]

해당 주소로 사용 시 기억하기 힘들어 custom domain을 설정해서 사용자에게 제공해야 됩니다.

1. Custom Domain 설정

---

커스텀 도메인을 생성하기 위해  APIGatewy console에서 Create domain name 탭에서 도메인을 입력합니다.

이후 ACM Certificate를 추가해야 되는데, 이미 ACM을 통해 생성한 인증서가 있을 경우 선택하고, 없으면 새롭게 인증서를 생성합니다. ACM 콘솔에서 Request Certificate를 통해 인증서를 생성하고, 위에서 입력한 전체 도메인을 입력합니다. 다만 인증 방법에서 DNS validation을 이용하려면 레코드를 생성해야 하기 때문에 Route53에서 해당 레코드를 생성할 수 있는  권한이 있어야 됩니다.

이후 생성 시 다음과 같이 Pending validation으로 활성화가 되지 않고 있습니다.

활성화를 위해 create records in Route53을 버튼을 클릭하여 레코드를 생성합니다.(아마 다른 DNS 호스팅 서비스를 이용할 경우, CNAM으로 레코드를 생성하면 되지 않을까 싶습니다..). 레코드가 생성되면 다음과 같이 Status가 Success로 변경됩니다.

이후 API Gateway에서 해당 Certificate를 선택 후 생성합니다. 생성되면 다음과 같이 API Gateway domain name이 생성됩니다.

도메인 생성 후 API mappings에서 어떤 API의 Stage와 매핑할지 설정을  추가합니다.

다음과 같이 설정 완료 후 생성된 경로를 바탕으로 Route53에서 도메인 등록을 통해 사용할 수 있습니다. 간단하게 해당 도메인을 CNAM으로 등록해도 되고, 다음과 같이 A record설정 후 Alias를 통해 AWS Resource를 선택할 수 있습니다. 레코드 생성 후 적용까지의 시간이 좀 걸립니다.

이후 설정이 완료되면 해당 도메인을 통해 API Gateway에 접근할 수 있는 것을 확인할 수 있습니다. 다만 API Mappings 추가 시 Stage를 선택하기 때문에 기존에 포함된 stage 경로가 빠진 상태로 조회할 수 있습니다.