API 등록

Apigee X 문서입니다.
Apigee Edge 문서 보기

API를 등록하면 뷰어가 API 목록에서 검색할 수 있습니다.

API 등록

API 등록

API를 등록하려면 다음 안내를 따르세요.

  1. Cloud Console에서 Apigee API 허브 페이지로 이동합니다.

    API 허브로 이동

    기본적으로 API 목록 페이지가 표시됩니다.

  2. API 등록을 클릭합니다. API 등록 창이 열립니다.
  3. 다음 API 세부정보를 지정합니다.
    • ID: API 리소스의 식별자입니다. ID는 소문자, 숫자, 하이픈만 포함할 수 있습니다. ID는 프로젝트에서 고유해야 합니다. ID는 4~63자여야 합니다. API가 등록된 후에는 ID를 변경할 수 없습니다. 예를 들어 API 리소스 이름 projects/my-project/locations/global/apis/my-api의 경우 리소스 ID는 my-api입니다.
    • 이름: API 이름을 입력합니다.
    • 설명: API 설명을 입력합니다.
    • 스타일:
      • 스타일: API의 기본 아키텍처 스타일을 선택합니다. 예를 들어 API 허브가 구성된 방식에 따라 OpenAPI, GraphQL, AsyncAPI 등을 선택할 수 있습니다.
      • API 설명 문서: 기존 설명 문서가 있으면 찾아보기를 클릭하여 업로드합니다. 단일 파일이나 zip 파일(최대 2MB)일 수 있습니다. 버전 추가 및 삭제에 대한 자세한 내용은 버전 관리를 참조하세요.
      • MIME 유형: MIME 유형을 선택합니다. API 설명 문서를 선택하면 MIME 유형이 표시됩니다. 기타를 선택하면 MIME 유형을 수동으로 지정할 수 있는 텍스트 필드가 표시됩니다.
    • 현재 버전:
      • 버전 ID: API 리소스의 이름입니다. ID는 소문자, 숫자, 하이픈만 포함할 수 있습니다. 버전 ID는 프로젝트에서 고유해야 합니다. 버전 ID는 1~63자(영문 기준)여야 합니다. API가 등록된 후에는 버전 ID를 변경할 수 없습니다.
      • 버전: 초기 버전을 입력합니다.
      • API 수명 주기 단계: 목록에서 수명 주기 단계를 선택합니다.
    • 예상 지원 종료:
      • 목록에서 예상을 선택합니다.
      • 예상최소 날짜인 경우 날짜를 지정합니다.
      • 예상확인된 날짜인 경우 날짜를 지정합니다.
    • 속성:
      • 시스템 분류:
        • 대상 사용자: API의 대상 사용자(소비자)를 선택합니다.

        • 팀: API 제작을 담당하는 팀을 선택합니다.
        • 사업부 API를 담당하는 사업부를 선택합니다.
      • 커스텀 분류:
        • 나열된 다른 커스텀 분류를 선택합니다.
    • 기본 연락처:
      • 기본 연락처 이메일 주소: API에 대한 질문의 기본 연락처 이메일 주소
      • 기본 연락처 설명: 기본 연락처의 설명
  4. API 등록 또는 취소를 클릭합니다.

API 등록 세부정보 수정

API 등록 세부정보를 수정하려면 다음 안내를 따르세요.

  1. Cloud Console에서 Apigee API 허브 페이지로 이동합니다.

    API 허브로 이동

    기본적으로 API 목록 페이지가 표시됩니다.

  2. API를 클릭합니다. API 개요 페이지가 열립니다.
  3. 수정을 클릭합니다.
  4. 세부정보를 수정합니다.
  5. 저장 또는 취소를 클릭합니다.

API 삭제

API를 삭제하면 시스템에서 API가 제거됩니다. 기존 사용자를 위해 API를 유지해야 한다면 API를 삭제하는 대신 사용 중단 또는 폐기 수명 주기 단계를 사용해 보세요.

API를 삭제하려면 다음 안내를 따르세요.

  1. Cloud Console에서 Apigee API 허브 페이지로 이동합니다.

    API 허브로 이동

    기본적으로 API 목록 페이지가 표시됩니다.

  2. API를 클릭합니다. API 개요 페이지가 열립니다.
  3. API 삭제를 클릭합니다.
  4. 확인 대화상자가 표시됩니다. API 이름을 입력한 후 확인(또는 취소)를 클릭합니다.

    API 삭제 확인