Cloud Endpoints 포털을 사용하여 시작하기

이 페이지에서는 Cloud Endpoints 서비스를 위한 포털을 만드는 방법을 설명하고 포털 사용자 인터페이스를 소개합니다. 각 작업을 완료하기 위해 필요한 최소한의 Cloud Identity and Access Management 역할이 제공됩니다. Cloud IAM 권한에 대한 자세한 내용은 다음을 참조하세요.

기본 요건

이 페이지에서는 다음 작업을 이미 완료했다고 가정합니다.

포털 만들기

포털을 만들려면 다음 단계를 따르세요.

  1. Google Cloud Console에서 Endpoints > 개발자 포털 페이지로 이동합니다.

    Cloud Endpoints 포털로 이동

  2. API가 있는 Cloud 프로젝트를 선택합니다.
  3. 포털 만들기를 클릭합니다. 포털 생성에는 일반적으로 5~10 분이 소요됩니다. 포털이 준비되면 포털 URL이 표시됩니다.

포털을 만들면 다음과 같은 효과가 있습니다.

  • 포털 생성 중에 service-YOUR_PROJECT_NUMBER@endpoints-portal.iam.gserviceaccount.com이라는 서비스 계정이 Endpoints 포털 서비스 에이전트 역할로 생성됩니다. YOUR_PROJECT_NUMBER는 Cloud 프로젝트의 프로젝트 번호입니다. Cloud 프로젝트의 IAM 및 관리자> IAM 페이지에서 Cloud Console의 이 서비스 계정을 확인할 수 있습니다.

  • 포털이 생성되면 도메인 이름 endpointsportal.YOUR_PROJECT_ID.cloud.goog를 사용합니다. YOUR_PROJECT_ID는 Cloud 프로젝트 ID입니다. 이를 지원하도록 SSL/TLS 인증서 및 프로젝트 ID가 포함된 공개 DNS 레코드가 생성됩니다. 그리고 포털에 공개적으로 액세스할 수 없더라도 공개 인증서 투명성 로그에서 포털을 검색할 수 있습니다.

API용 포털 보기

API용 포털을 보려면 다음 단계를 따르세요.

  1. Endpoints > 개발자 포털 페이지의 포털 URL 섹션에서 URL을 클릭합니다.
  2. 로그인 메시지를 따라 포털을 계속 진행합니다. 계정이 두 개 이상 있는 경우 API가 포함된 Google Cloud 프로젝트에 있는 계정을 선택해야 합니다.

    포털의 홈페이지가 표시됩니다. 편의를 위해 이 URL을 북마크에 추가하는 것이 좋습니다. 포털 홈페이지에는 Cloud 프로젝트의 모든 API에 대한 링크 목록이 표시됩니다.

  3. 탐색할 API를 클릭합니다. API의 홈페이지가 표시됩니다.

포털 UI 소개

API의 홈페이지 아래에서 다음 아이콘은 API 사용자에 대해 유용한 링크를 제공합니다.

  • API 참조 는 Endpoints Frameworks가 만든 openapi.json 파일로부터 Endpoints 포털이 생성한 SmartDocs API 참조 문서의 첫 번째 페이지를 표시합니다. 왼쪽의 탐색 메뉴를 사용하여 각 메서드 및 리소스에 대한 SmartDocs 문서를 볼 수 있습니다.

  • 시작하기 에는 시작 가이드의 예시 콘텐츠가 표시됩니다. API 사용자에게 포털 URL을 전송하기 전에 이 문서를 맞춤설정하여 API 사용자가 자신의 코드에서 개발자의 API 사용을 시작하는 데 필요한 정보를 제공합니다. 시작 가이드의 콘텐츠를 수정하는 방법에 대한 자세한 내용은 커스텀 문서 추가를 참조하세요.

  • 키 가져오기 에는 사용자가 자신의 고유 Google Cloud 프로젝트에서 개발자의 API를 사용 설정할 수 있도록 API 및 서비스 > API 라이브러리 페이지가 표시됩니다.

    API에 API 키가 필요한 경우 사용자가 개발자의 API를 사용 설정한 후 API 및 서비스 > 사용자 인증 정보 페이지로 이동하여 사용자가 자신의 코드에서 사용할 수 있는 API 키를 가져옵니다. API 사용자에게 포털 URL을 보내기 전에 사용자에게 API를 사용할 수 있는 액세스 권한을 부여해야 합니다. 자세한 내용은 API 사용 설정 권한 제어를 참조하세요.

포털 모양 맞춤설정

포털에 표시되는 색 구성표 및 아이콘과 같은 요소를 회사 웹사이트와 일치하도록 변경할 수 있습니다. 포털 모양을 변경하고 커스텀 도메인을 설정하면 사용자를 위한 브랜드 환경을 만들 수 있습니다.

포털 모양을 맞춤설정하려면 다음 안내를 따르세요.

  1. 페이지 오른쪽 상단 모서리에 있는 설정 settings을 클릭합니다.

  2. 사이트 전체 탭을 클릭합니다. 다음 항목의 모양을 변경할 수 있습니다.

    • 로고
    • 기본 색: 홈페이지와 제목 표시줄 배경색으로 사용됨
    • 보조 색: 아이콘과 링크 색으로 사용됨
    • 홈페이지 제목
    • 홈페이지 설명
  3. 저장을 클릭합니다.

포털 삭제

포털을 삭제하려면 다음 안내를 따르세요.

  1. Cloud Console에서 Endpoints > 개발자 포털 페이지로 이동합니다.

    Cloud Endpoints 포털로 이동

  2. API가 있는 Cloud 프로젝트를 선택합니다.
  3. 삭제를 클릭합니다. delete
  4. 확인 대화상자에서 삭제를 클릭합니다.

다음 단계

다음 사항에 대해 알아보세요.