API Gateway에서 포털 생성 - Amazon API Gateway

API Gateway에서 포털 생성

포털은 제품 모음입니다. 포털의 권한 부여, 브랜딩 및 게시를 제어합니다. 포털을 생성할 때 게시 상태는 Disabled입니다. 즉, 웹에서 포털을 검색할 수 없습니다. 소비자가 포털에 액세스할 수 있도록 하려면 포털을 게시해야 합니다. 포털을 게시하기 전에 미리 볼 수도 있습니다.

API Gateway는 다음 브라우저에서 포털을 지원합니다.

  • Firefox

  • Google Chrome

  • Microsoft Edge

  • Safari

도메인 이름 선택

기본적으로 포털 URL은 다음 Amazon 소유 도메인 이름으로 호스팅됩니다.

https://p-portalId.apigw-portal.us-east-1.on.aws

도메인 이름을 사용자 지정하려면 소유한 도메인 이름과 사용자 지정 도메인에 대한 SSL 인증서를 제공할 수 있습니다. 인증서는 미국 동부(버지니아 북부)의 AWS Certificate Manager(ACM)으로 관리해야 하며 Amazon CloudFront에서 지원해야 합니다. 자세한 내용은 CloudFront에서 SSL/TLS 인증서를 사용하기 위한 요구 사항을 참조하세요.

사용자 지정 도메인 이름을 사용하는 경우 API Gateway는 ACM 인증서로 전송 중 보호되는 CloudFront 배포를 생성합니다. 그런 다음 API Gateway는 DNS 구성에 추가하는 별칭 레코드를 제공합니다. 별칭 레코드는 Amazon 소유 도메인 이름입니다. 트래픽을 사용자 지정 도메인의 CloudFront 배포로 보내려면 이 별칭 레코드를 추가해야 합니다. 제공하는 도메인 이름은 고유해야 하며 기존 CloudFront 배포의 별칭 목록에서 아직 사용되지 않아야 합니다.

자체 도메인 이름을 사용하는 경우 API Gateway는 TLS_1_2 보안 정책을 사용하여 포털을 보호합니다. 자세한 내용은 뷰어 간에 지원되는 프로토콜 및 암호를 참조하세요. 이 값은 변경할 수 없습니다.

포털 생성

API Gateway 콘솔을 사용하여 포털을 생성하고 구성합니다. 다음 절차는 필요한 모든 단계를 안내합니다. 첫 번째 절차가 끝날 때 검토 및 생성으로 건너뛰기를 선택하여 빈 포털을 생성할 수도 있습니다.

다음 절차는 포털을 생성하는 방법을 보여 줍니다. 먼저 포털 세부 정보를 정의합니다.

포털 세부 정보 정의
  1. https://console.aws.amazon.com/apigateway에서 API Gateway 콘솔에 로그인합니다.

  2. 기본 탐색 창에서 포털을 선택합니다.

  3. 포털 생성을 선택합니다.

  4. 포털 세부 정보의 포털 이름에 이름을 입력합니다.

  5. 포털 설명에 설명을 입력합니다.

  6. 포털 권한 부여에서 포털 권한 부여 방법을 선택합니다.

    • 포털을 처음 생성하는 경우 없음을 선택하는 것이 좋습니다. 포털에 프로덕션 API 추가하려는 경우 권한 부여 필요를 사용합니다.

    • 포털 소비자가 포털을 사용하도록 인증하도록 하려면 권한 부여 필요를 선택하고 다음을 수행합니다.

      1. Amazon Cognito 사용자 풀에서 사용자 풀을 선택합니다.

        사용자 풀은 포털과 동일한 리전에 있어야 합니다.

      2. 애플리케이션 클라이언트 ID에서 앱 클라이언트 ID를 선택합니다.

        앱 클라이언트에서 콜백 URL을 포털의 기본 URL로 설정해야 합니다.

      3. 사용자 풀 도메인에 사용자 풀 도메인을 입력합니다. 자세한 내용은 사용자 풀 도메인 구성을 참조하세요.

  7. 도메인 구성에서 포털의 도메인 이름을 선택합니다.

    • 포털을 처음 생성하는 경우 기본 도메인을 선택하는 것이 좋습니다. 포털을 게시하면 https://p-portalId.apigw-portal.us-east-1.on.aws에서 사용할 수 있습니다.

    • 소유한 사용자 지정 도메인 이름을 제공하려면 사용자 지정 도메인 이름을 선택하고 다음을 수행합니다.

      1. 도메인 이름에 정규화된 도메인 이름을 입력합니다.

      2. ACM 인증서에서 도메인 이름을 포함하는 ACM 인증서를 선택합니다.

        포털에서 트래픽을 처리하려면 API Gateway가 프로비저닝하는 별칭 레코드를 DNS 레코드에 추가해야 합니다.

  8. 포털에 CloudWatch RUM 앱 모니터를 추가하려면 RUM 앱 모니터에서 앱 모니터를 선택합니다. 자세한 내용은 CloudWatch RUM을 참조하세요.

  9. 다음을 선택합니다.

포털 세부 정보를 정의한 후 포털 제품을 추가합니다. 포털에서 언제든지 포털 제품을 변경할 수 있지만 변경 사항을 적용하려면 포털을 다시 게시해야 합니다.

포털 제품 선택
  1. 리소스 목록에서 포털에 추가할 제품을 선택합니다.

  2. 다음을 선택합니다.

제품을 선택한 후 포털 설계를 사용자 지정합니다. 포털 로고를 업로드하려면 Amazon S3에 이미지를 업로드해야 합니다. 언제든지 이러한 값을 변경할 수 있지만 변경 사항을 적용하려면 포털을 다시 게시해야 합니다.

(선택 사항) 포털 사용자 지정
  1. 포털 로고에 파일의 S3 URI를 입력합니다.

    .svg, .png 또는 .jpg만 지원됩니다.

  2. 포털의 설계를 사용자 지정하려면 다음 두 가지 옵션이 있습니다.

    1. 포털 테마를 선택하여 포털에 미리 만든 색상 테마를 적용할 수 있습니다.

    2. 색상 선택기를 사용하여 모든 포털 설계 옵션을 선택할 수 있습니다.

  3. 다음을 선택합니다.

포털 설계를 선택한 후 포털에 대한 정보를 검토합니다.

포털 검토
  • 검토 및 생성 페이지에서 설정을 검토합니다. 설정에 만족하면 [생성(Create)]을 선택합니다.

Amazon Cognito 사용자 풀을 사용하여 포털에 대한 액세스를 제어하는 경우 콜백 URL을 앱 클라이언트의 포털 기본 URL로 설정해야 합니다. 자세한 내용은 앱 클라이언트를 사용한 애플리케이션별 설정을 참조하세요.

포털을 생성한 후에는 소비자가 포털을 사용할 수 없습니다. 인터넷에서 액세스할 수 있으려면 포털을 게시해야 합니다. 자세한 내용은 API Gateway에 포털 게시 섹션을 참조하세요.