API 사용해 보기

개발자는 SmartDocs API 참조 문서를 검토하는 것 외에도 API 사용해 보기 패널을 사용하여 API 문서에서 나가지 않고도 API와 상호작용할 수 있습니다. 포털에서 개발자는 API에 요청을 전송하고 응답을 확인할 수 있습니다. 포털에서 API를 사용해 보면 사용자들이 이 API에서 자신의 코드를 작동하는 데 필요한 것이 무엇인지 이해하는 데 도움이 됩니다.

API에 API 키 또는 인증이 필요한 경우 사용자가 API와 상호작용할 수 있도록 포털을 구성해야 합니다. 이 페이지에서는 개발자가 API 사용해 보기를 사용하는 데 필요한 구성 및 요구사항을 설명합니다. 각 작업별로 작업 완료에 필요한 최소한의 ID 및 액세스 관리 역할이 제공됩니다. IAM 권한에 대한 자세한 내용은 다음을 참조하세요.

기본 요건

  • API 백엔드를 배포해야 합니다.
  • API에 API 키가 필요한 경우 API 키로 API 액세스 제한의 설명에 따라 OpenAPI 문서를 구성해야 합니다.
  • API에 인증이 필요한 경우 선택한 인증 방법으로 OpenAPI 문서를 구성해야 합니다. 인증 방법 선택을 참조하세요.
  • DNS를 통해 API에 연결할 수 있어야 합니다.

    • App Engine 가변형 환경에 API를 배포한 경우 이름이 YOUR_PROJECT_ID.appspot.com 형식인 DNS 항목이 자동으로 생성됩니다. 위의 예시에서 YOUR_PROJECT_ID는 API를 배포한 Google Cloud 프로젝트의 ID입니다. 따라서 추가 구성 없이도 포털에서 API를 테스트할 수 있습니다.
    • Compute Engine 또는 GKE와 같은 다른 백엔드의 경우 API가 커스텀 도메인 이름(예: myapi.mycompany.com)을 사용하도록 구성되지 않은 경우 cloud.goog 도메인을 사용하도록 API를 구성해야 합니다.

API 탐색기 설정 구성

API에 API 키 또는 Firebase나 Auth0 인증이 필요한 경우 사용자가 API를 사용하기 전에 이러한 설정을 구성해야 합니다. 이 섹션에서는 API 키 및 인증 설정을 구성하는 방법에 대해 설명합니다.

API 키 구성

포털에서 API 키를 구성하려면 다음 안내를 따르세요.

  1. Google Cloud Console에서 API 및 서비스> 사용자 인증 정보로 이동합니다.

    사용자 인증 정보 페이지로 이동

  2. Cloud Console 창의 프로젝트 드롭다운 목록에서 API를 만든 Google Cloud 프로젝트를 선택합니다.

    • 사용하려는 기존 API 키가 있다면 다음 안내를 따르세요.

      1. 사용할 API 키 옆에 있는 API 키 수정 아이콘을 클릭합니다.
      2. API 키 오른쪽에서 복사 아이콘을 클릭하여 API 키를 클립보드에 복사합니다.
      3. 취소를 클릭합니다.
    • API 키를 생성해야 하는 경우에는 다음 안내를 따르세요.

      1. 사용자 인증 정보 만들기를 클릭한 후 API 키를 선택합니다.
      2. 클립보드에 키를 복사합니다.
      3. 닫기를 클릭합니다.
  3. 포털로 돌아갑니다.

  4. 설정 아이콘을 클릭합니다.

  5. API 탭을 클릭하고 드롭다운 목록에서 API를 선택합니다.

  6. API 탐색기 설정 섹션에서 API 키를 Google API 키 필드에 붙여 넣습니다.

  7. 저장을 클릭합니다.

Firebase 구성

Firebase를 구성하려면 다음 안내를 따르세요.

  1. Firebase Console을 엽니다.

    • 기존 Firebase 프로젝트가 없으면 다음 안내를 따르세요.

      1. 프로젝트 추가를 클릭하고 API가 있는 Google Cloud 프로젝트 이름을 선택합니다.
      2. 인증 카드에서 시작하기를 클릭합니다.
      3. 로그인 방법 탭을 클릭합니다.
      4. 로그인 공급업체 섹션에서 사용할 공급업체를 사용 설정합니다.
      5. 승인된 도메인 섹션에서 도메인 추가를 클릭하고 포털 도메인 이름(예: endpointsportal.example-api.example.com)을 추가합니다.
      6. 웹 설정을 클릭합니다. 맞춤설정된 코드 스니펫이 표시됩니다. 다음 단계에서 이 코드 스니펫의 정보를 사용해야 하므로 Firebase Console은 열어둡니다.
    • 기존 Firebase 프로젝트가 있으면 다음 안내를 따르세요.

      1. 개발 > 인증으로 이동합니다.
      2. 로그인 방법 탭을 클릭합니다.
      3. 승인된 도메인 섹션에서 도메인 추가를 클릭하고 포털 도메인 이름(예: endpointsportal.example-api.example.com)을 추가합니다.
      4. 웹 설정을 클릭합니다. 맞춤설정된 코드 스니펫이 표시됩니다. 다음 단계에서 이 코드 스니펫의 정보를 사용해야 하므로 Firebase Console은 열어둡니다.
  2. 브라우저에서 다른 탭을 열고 포털로 이동합니다.

  3. 설정 아이콘을 클릭합니다.

  4. 설정 페이지에서 API 탭을 클릭하고 드롭다운 목록에서 API를 선택합니다.

  5. API 탐색기 설정 섹션에서 다음을 수행합니다.

    1. Firebase 코드 스니펫에서 apiKey 필드 값을 복사하여 Google API 키 필드에 붙여 넣습니다.
    2. Firebase 코드 스니펫에서 authDomain 필드 값을 복사하여 Firebase 인증 도메인 필드에 붙여 넣습니다.
  6. 저장을 클릭합니다.

자세한 내용은 Firebase 문서를 참조하세요.

Auth0 구성

아래의 개략적인 작업 목록을 사용하여 Auth0 및 포털을 구성합니다.

작업 1. Cloud Endpoints 서비스에 Auth0 API가 있는지 확인합니다.

작업 2. Auth0 애플리케이션 설정을 구성합니다.

작업 3. 포털에서 Auth0 설정을 구성합니다.

작업 1: Endpoints 서비스에 Auth0 API가 있는지 확인

  1. Auth0 대시보드에 로그인합니다.
  2. 왼쪽 탐색 메뉴에서 API를 클릭합니다. https://SERVICE_NAME 형식(여기서 SERVICE_NAME은 Endpoints 서비스의 이름)의 API 대상이 있으면 API가 이미 생성된 것입니다. 다음 작업을 계속하여 Auth0 애플리케이션 설정을 구성하세요.

    그렇지 않으면 API를 만듭니다.

    1. + API 만들기를 클릭합니다.
    2. 이름을 입력합니다.
    3. 식별자 필드에 https://SERVICE_NAME 형식으로 URL을 입력합니다.

      SERVICE_NAME을 Endpoints 서비스 이름으로 바꿉니다. 서비스 이름을 확실히 알지 못할 경우 Endpoints 서비스 이름 찾기에 대한 자세한 내용은 서비스 이름 및 구성 ID 가져오기를 참조하세요.

    4. 만들기를 클릭합니다.

작업 2: Auth0 애플리케이션 설정 구성

  1. Auth0 대시보드의 왼쪽 탐색 메뉴에서 애플리케이션을 클릭합니다.
  2. Auth0 애플리케이션을 선택하거나 + 애플리케이션 만들기를 클릭하여 새 애플리케이션을 만듭니다.
  3. 애플리케이션의 설정 탭에서 아래로 스크롤하고 허용된 콜백 URL 필드에 포털의 OAuth 리디렉션 URL을 추가합니다. 포털의 OAuth 리디렉션 URL은 포털 URL에 /oauth/redirect가 추가된 것입니다(예: https://endpointsportal.example-api.example.com/oauth/redirect).

    허용된 콜백 URL 필드에는 여러 URL을 쉼표로 구분하여 입력할 수 있습니다. 입력하는 URL에 후행 / 문자를 포함하지 않아야 합니다.

  4. 변경사항 저장을 클릭합니다.

    다음 단계에서 이 정보가 필요하므로 Auth0 설정 브라우저 탭을 열어두세요.

작업 3: 포털에서 Auth0 설정 구성

  1. 브라우저에서 다른 탭을 열고 포털로 이동합니다.
  2. 설정 아이콘을 클릭합니다.
  3. 설정 페이지에서 API 탭을 클릭하고 드롭다운 목록에서 API를 선택합니다.
  4. API 탐색기 설정 섹션에서 다음을 수행합니다.

    1. Auth0 대시보드에서 클라이언트 ID 필드 값을 복사하여 Auth0 클라이언트 ID 필드에 붙여 넣습니다.
    2. Auth0 대시보드에서 도메인 필드 값을 복사하여 Auth0 도메인 필드에 붙여 넣습니다.
  5. 저장을 클릭합니다.

Auth0 구성에 대한 자세한 내용은 Auth0 문서의 Auth0 대시보드 개요를 참조하세요.