API 스테이지를 REST API에 대한 사용자 지정 도메인 이름에 매핑
API 매핑을 사용하여 API 스테이지를 사용자 지정 도메인 이름에 연결합니다. 도메인 이름을 생성하고 DNS 레코드를 구성한 후에는 API 매핑을 사용하여 사용자 지정 도메인 이름을 통해 API로 트래픽을 보냅니다.
API 매핑은 API, 스테이지 및 매핑에 사용할 경로(선택 사항)를 지정합니다. 예를 들어 API의 production 스테이지를 https://api.example.com/orders에 매핑할 수 있습니다.
HTTP 및 REST API 스테이지를 동일한 사용자 지정 도메인 이름에 매핑할 수 있습니다.
API 매핑을 생성하기 전에 API, 스테이지 및 사용자 지정 도메인 이름이 있어야 합니다. 사용자 지정 도메인 이름 생성에 대한 자세한 내용은 API Gateway에서 리전 사용자 지정 도메인 이름 설정 단원을 참조하세요.
API 요청 라우팅
여러 수준(예: orders/v1/items 및 orders/v2/items)으로 API 매핑을 구성할 수 있습니다.
참고
여러 수준으로 API 매핑을 구성하려면 TLS 1.2 보안 정책이 적용된 리전 사용자 지정 도메인 이름을 사용해야 합니다.
여러 수준 API 매핑의 경우 API Gateway는 일치하는 경로가 가장 긴 API 매핑으로 요청을 라우팅합니다. API Gateway는 호출할 API를 선택하기 위해 API 경로가 아닌 API 매핑에 대해 구성된 경로만 고려합니다. 요청과 일치하는 경로가 없으면 API Gateway는 빈 경로 (none)에 매핑한 API로 요청을 보냅니다.
여러 수준 API 매핑을 사용하는 사용자 지정 도메인 이름의 경우 API Gateway는 일치하는 경로가 가장 긴 API 매핑으로 요청을 라우팅합니다.
예를 들어 다음 API 매핑이 있는 사용자 지정 도메인 이름 https://api.example.com을(를) 살펴보겠습니다.
-
(none)이(가) API 1에 매핑됩니다. -
orders이(가) API 2에 매핑됩니다. -
orders/v1/items이(가) API 3에 매핑됩니다. -
orders/v2/items이(가) API 4에 매핑됩니다. -
orders/v2/items/categories이(가) API 5에 매핑됩니다.
| 요청 | 선택한 API | 설명 |
|---|---|---|
|
|
|
요청은 이 API 매핑과 정확히 일치합니다. |
|
|
|
요청은 이 API 매핑과 정확히 일치합니다. |
|
|
|
요청은 이 API 매핑과 정확히 일치합니다. |
|
|
|
API Gateway는 일치하는 경로가 가장 긴 매핑을 선택합니다. 요청 끝에 있는 |
|
|
|
API Gateway는 일치하는 경로가 가장 긴 매핑을 선택합니다. |
|
|
|
API Gateway는 빈 매핑을 캐치 올(catch-all)로 사용합니다. |
|
|
|
API Gateway는 일치하는 접두사가 가장 긴 매핑을 선택합니다. 단일 수준 매핑으로 구성된 사용자 지정 도메인 이름(예: 단지 |
제한 사항
-
API 매핑에서 사용자 지정 도메인 이름과 매핑된 API는 동일한 AWS 계정에 있어야 합니다.
-
API 매핑에는 문자, 숫자 및 문자
$-_.+!*'()/만 포함해야 합니다. -
API 매핑에서 경로의 최대 길이는 300자입니다.
-
각 도메인 이름에 대해 여러 수준의 API 매핑이 200개 있을 수 있습니다.
-
TLS 1.2 보안 정책을 사용하여 HTTP API를 리전별 사용자 지정 도메인 이름에만 매핑할 수 있습니다.
-
WebSocket API를 HTTP API 또는 REST API와 동일한 사용자 지정 도메인 이름에 매핑할 수 없습니다.
API 매핑 생성
API 매핑을 생성하려면 먼저 사용자 지정 도메인 이름, API 및 스테이지를 생성해야 합니다. 사용자 지정 도메인 이름 생성에 대한 자세한 내용은 API Gateway에서 리전 사용자 지정 도메인 이름 설정 단원을 참조하세요.
예를 들어 모든 리소스를 생성하는 AWS Serverless Application Model 템플릿에 대해서는 GitHub의 SAM 세션
