API Connect 툴킷 설정

CLI 명령 및 IBM® API Connect용 API Designer 사용자 인터페이스를 제공하는 툴킷을 설치하십시오.

이 태스크에 대한 정보

툴킷을 사용하여 API에 대한 작업 방법을 선택할 수 있습니다.

  • API Designer 는 API Manager와 유사한 그래픽 인터페이스를 제공합니다. 로컬에서 작업하기 때문에 API Designer에서 모든 API Manager 기능을 사용할 수 있는 것은 아닙니다.
  • CLI(Command Line Interface)로 그래픽 인터페이스를 사용하는 대신 명령 창에서 작동할 수 있습니다.
툴킷 설정은 다음 태스크를 포함합니다.

툴킷 다운로드

이 태스크에 대한 정보

툴킷을 설치하려면 선택한 툴킷 옵션 및 플랫폼에 적합한 압축 파일을 다운로드한 후 로컬 시스템의 선택한 위치에 컨텐츠를 추출하십시오. 압축 파일에는 CLI 명령을 실행하기 위한 실행 파일 및 CLI+Designer 옵션을 선택하는 경우 API Designer 애플리케이션을 실행하기 위한 실행 파일이 포함되어 있습니다.

프로시저

  1. IBM API Connect의 API Manager에서 툴킷을 다운로드하십시오.
    1. IBMid 을 사용하여 API 관리자에 로그인합니다.
    2. API 관리자 홈페이지에서 도구 다운로드 링크를 클릭합니다.
    3. API Connect 툴킷 설치 창의 "1단계: 툴킷 다운로드" 섹션에서 다운로드할 패키지 유형을 선택하고 운영 체제에 해당하는 링크를 클릭하십시오.
      • CLI: IBM API Connect에 대한 작업을 수행하기 위한 명령행 환경을 제공합니다.
      • CLI+Designer: IBM API Connect및 API Designer 사용자 인터페이스에 대해 작업하기 위한 명령행 환경을 제공합니다.
  2. "2단계: 신임 정보 다운로드" 섹션에서 두 신임 정보 파일을 다운로드하십시오.
    1. 신임 정보 에 대한 다운로드 옵션을 클릭하고 credentials.json 파일을 로컬 파일 시스템에 저장하십시오.
    2. API Designer 신임 정보 에 대한 다운로드 옵션을 클릭하고 designer_credentials.json 파일을 로컬 파일 시스템에 저장하십시오.
  3. 컴퓨터에서 다운로드한 툴킷 압축 파일을 찾아 원하는 폴더에 내용을 압축 해제합니다.

    파일의 내용은 다음과 같이 선택한 툴킷 옵션 및 플랫폼에 따라 달라집니다:

    • apic-slim 또는 apic-slim.exe 파일은 IBM API Connect용 CLI입니다.
    • apic 또는 apic.exe 파일은 IBM API Connect용 CLI입니다.
      팁: CLI 옵션을 사용하는 경우, apic-slim 파일의 이름을 apic로 바꾸거나 apic-slim.exe 파일을 apic.exe로 바꾸면 CLI 명령을 문서에 설명된 대로 정확하게 실행하고, 문서에서 샘플 명령을 복사하여 붙여넣을 수 있으며, 나중에 CLI+Designer 옵션으로 이동하는 경우 명령 스크립트를 그대로 사용할 수 있습니다.
    • api_designer-platform 파일은 지정된 플랫폼에 대한 API Designer 사용자 인터페이스 애플리케이션입니다.
  4. CLI를 실행하십시오.
    • Mac OSX 또는 Linux® 플랫폼의 경우 다음 단계를 완료하십시오.
      1. 터미널 인스턴스를 열고 툴킷 압축 파일의 내용을 추출한 폴더로 이동합니다.
      2. 다음 명령을 입력하여 CLI 파일을 실행 파일로 설정하십시오.
        chmod +x download_name
        여기서 download_name은 다운로드한 툴킷 파일의 이름(apic 또는 apic-slim)입니다.
      3. 다음과 같이 CLI 명령을 실행하십시오.
        ./apic command_name_and_parameters
        또는
        ./apic-slim command_name_and_parameters
        CLI 명령에 대한 세부사항은 툴킷 CLI 참조 문서를 참조하십시오.
    • Windows 플랫폼의 경우 다음 단계를 완료하십시오.
      1. 명령 프롬프트를 열고 툴킷 압축 파일의 내용을 추출한 폴더로 이동합니다.
      2. 다음과 같이 CLI 명령을 실행하십시오.
        apic command_name_and_parameters
        또는
        apic-slim command_name_and_parameters
        CLI 명령에 대한 세부사항은 툴킷 CLI 참조 문서를 참조하십시오.
    팁: 파일 시스템의 임의의 위치에서 CLI 명령을 실행할 수 있도록 CLI 파일의 폴더 위치를 PATH 변수에 추가하십시오.
  5. 툴킷 신임 정보 설치:

    터미널 창 (또는 Windows 명령 프롬프트) 을 열고 다음 명령을 실행하여 툴킷 신임 정보를 설치하십시오.

    apic client-creds:set <toolkit_credentials_file_path>/credentials.json

    여기서 < credentials_file_path> 는 툴킷 신임 정보 JSON 파일을 다운로드한 위치입니다. 툴킷은 이러한 새 신임 정보를 사용하여 API Manager를 호스트하는 서버를 인증합니다.

  6. API Designer 신임 정보를 설치하십시오.

    운영 체제에 적합한 메커니즘을 사용하여 APIC_DESIGNER_CREDENTIALS 환경 변수를 신임 정보 다운로드 위치로 설정하여 API Designer 신임 정보를 설치하십시오.

    Windows: 다음 방법 중 하나를 사용하여 환경 변수를 작성하십시오.

    • 컴퓨터의 임의의 위치에서 API Designer를 시작할 수 있도록 영구 환경 변수를 작성하십시오.
      1. 환경 변수 페이지를 여십시오. 시작 > 설정 > 시스템 을 클릭하고 페이지의 "관련 설정" 섹션에서 고급 시스템 설정을 클릭하십시오.
      2. 시스템 특성 대화 상자의 고급 탭에서 환경 변수를 클릭하십시오.
      3. "사용자 변수" 섹션에서 새로 작성 을 클릭하고 다음 설정으로 환경 변수를 작성하십시오.
        • 변수: APIC_DESIGNER_CREDENTIALS
        • 값: <designer_credentials_file_path>\designer_credentials.json . 여기서 <designer_credentials_file_path> 은 designer_credentials.json 파일을 저장한 위치입니다.
      4. 확인 을 클릭하여 새 환경 변수를 저장한 후 대화 상자를 종료하십시오.
    • API Designer 애플리케이션을 실행하는 동안에만 사용할 임시 환경 변수를 작성하십시오.

      API Designer를 시작할 때마다 다음 단계를 수행해야 합니다.

      1. Windows 명령 프롬프트를 여십시오.
      2. 다음 명령을 실행하여 임시 환경 변수를 설정하십시오.
        set APIC_DESIGNER_CREDENTIALS=<designer_credentials_file_path>\designer_credentials.json

        여기서 <designer_credentials_file_path> 은 designer_credentials.json 파일을 저장한 위치입니다.

        주: 다음 단계를 위해 명령 프롬프트를 열린 상태로 두십시오. 임시 변수를 설정하고 동일한 Windows 명령 세션 내에서 API Designer를 시작해야 합니다.
      3. 이제 다음 명령을 실행하여 API Designer를 시작하십시오.
        C:\"Program Files\API Designer\API Designer.exe"

        기본적으로 API Designer는 예제에 표시된 대로 C:\"Program Files\API Designer 폴더에 설치됩니다. 다른 위치에 설치한 경우 명령에서 사용자 고유의 위치를 사용하십시오. 경로 및 파일 이름에는 공백이 포함되어 있으므로 따옴표로 묶어야 합니다.

    Mac OS X 환경 변수를 생성하는 방법: 다음 방법 중 하나를 사용하여 환경 변수를 생성합니다

    • 다음 명령을 실행하여 영구 글로벌 환경 변수를 설정하십시오.
      launchctl setenv APIC_DESIGNER_CREDENTIALS <designer_credentials_file_path>/designer_credentials.json
      여기서 <designer_credentials_file_path> 는 API Designer 신임 정보 JSON 파일을 저장한 위치입니다.
    • 명령행에서 API Designer를 시작하는 동안 임시 환경 변수를 전달하십시오.

      이 방법을 사용하면 API Designer를 시작할 때마다 다음 명령을 실행해야 합니다.

      APIC_DESIGNER_CREDENTIALS=<designer_credentials_file_path>/designer_credentials.json open <designer_application_file_path>/'API Designer.app'
      상황:
      • <designer_credentials_file_path> 는 API Designer 신임 정보 JSON 파일을 다운로드한 위치입니다.
      • <designer_application_file_path> 는 API Designer 애플리케이션을 다운로드하여 압축 해제한 위치입니다.

툴킷에 로그인

이 태스크에 대한 정보

툴킷을 사용하여 IBM API Connect 관리 서버에 로그인하십시오.

프로시저

  1. 다음 명령을 실행하여 이전 로그인에서 툴킷 신임 정보를 지우십시오.
    apic client-creds:clear
    응답은 신임 정보가 삭제되었음을 확인합니다.
    Deleted client credentials

    신임 정보를 지우면 실수로 신임 정보의 틀린 세트(예: 다른 제품 릴리스 또는 환경으로부터)로 로그인하지 않도록 합니다. API Designer 신임 정보를 지우지 않아도 됩니다.

  2. 다음 명령을 실행하여 지금 사용할 신임 정보를 설정하십시오.
    apic client-creds:set <path_to_credentials>/credential.json
    여기서 <path_to_credentials> 은 사용할 credential.json 파일의 위치입니다. 예를 들어,
    apic client-creds:set /Users/local_user/credential.json
  3. 다음 명령을 실행하여 로그인하십시오.
    apic login --server <platform-api-host-name> --sso
    여기서 <platform-api-host-name> 는 호스트 이름 부분이고, URL 는 API 관리자("관리 서버")를 호스팅하는 서버입니다. 호스트 이름을 확인하려면 브라우저에서 API 관리자를 열고 주소 표시줄의 URL 에서 호스트 이름을 복사합니다(예: " https:// " 다음에 시작되고 "/manager" 앞에 끝남)
    https://platform-api.us-east-1.d-r01.apic.cloud.ibm.com/manager
  4. 툴킷이 컨텍스트에 대한 프롬프트를 표시하면 provider 를 입력하고 Enter를 누르십시오.
    Context? provider

    이제 API Manager 서버에 로그인했음을 나타내는 확인 메시지가 표시됩니다.

    로그아웃하려면 다음 명령을 실행하십시오.

    apic logout --server <api-manager-host-name>
    The response confirms your logout:
    Successfully logged out of <api-manager-host-name>