IBM App Connect Enterprise Designer 에서 REST API 가져오기

IBM® App Connect Enterprise Designer 에서 REST API를 가져와 메시지 흐름에서 사용할 수 있습니다.

시작하기 전에

“ IBM App Connect Enterprise Designer 시작하기”에 설명된 방법 중 하나를 사용하여 IBM App Connect Enterprise Designer를 시작하십시오.

태스크 정보

IBM App Connect Enterprise Designer 에서 REST API를 가져올 때, JSON 또는 YAML 형식의 OpenAPI 스키마를 사용하여 플로우에 REST 커넥터 노드를 추가할 수 있습니다. 이 노드를 추가하면 제공한 스키마에 맞게 사용자 정의된 사용자 정의 커넥터를 만들 수 있습니다. 스키마가 있는 모든 사용자 정의 REST API를 가져와서 플로우에 추가할 수 있습니다.

프로시저

다음 단계를 완료하여 REST API를 가져옵니다:

  1. 사이드바 탐색 메뉴에서 연결 > 애플리케이션 및 API > 를 클릭하세요.
    응용 프로그램 및 API 페이지가 열리고 사용 가능한 응용 프로그램 및 API 목록이 표시됩니다.
  2. +를 클릭하여 API를 추가하세요.
    커넥터 또는 API 추가 페이지가 열립니다. 문서 OpenAPI 가져오기 옵션이 기본적으로 선택되어 있습니다. 해당 Import 필드가 표시되며, '여기에 문서를 OpenAPI 드래그 앤 드롭하거나 클릭하여 가져오기' 링크를 포함합니다.
  3. 여기에 문서를 OpenAPI 드래그 앤 드롭하거나 클릭하여 로컬 파일 시스템을 열고 가져오기 하십시오.
  4. 파일 시스템에서 .yaml 파일을 .json 선택한 후 열기를 클릭하십시오.
    선택한 파일 .json 또는 .yaml 파일의 이름이 가져오기 필드에 표시됩니다.
  5. 다음을 클릭하십시오.
    속성 검토 창이 표시됩니다.
  6. 검토 속성 창에서 다음 작업을 완료하십시오:
    1. 이름 필드에서 자동 생성된 이름을 원하는 의미 있는 이름으로 변경하십시오. 예를 들어, TestingAPIforPets.
    2. 선택적으로 설명 필드에 설명을 입력하십시오.
    3. 작업을 선택하세요. 예를 들어 find_pet_by_id.
    4. API 가져오기를 클릭하세요.
    가져온 REST API는 플로우 생성 또는 계정 추가 시 표시되는 애플리케이션 및 API 목록에 추가됩니다.
  7. 다음 단계를 완료하여 REST API 가져오기가 성공적으로 완료되었는지 확인하십시오:
    1. 사이드바 탐색 메뉴에서 연결 > 애플리케이션 및 API를 클릭하세요.
      응용 프로그램 및 API 페이지가 열리고 사용 가능한 응용 프로그램 및 API 목록이 표시됩니다.
    2. 해당 Search 필드에 가져온 REST API의 이름 또는 이름 일부를 입력하세요.
      가져온 RESTAPI가 사용 가능한 애플리케이션 및 API 목록에 표시됩니다.

다음 수행할 사항

REST API를 가져온 후에는 다음 단계를 완료하여 메시지 흐름에서 사용할 수 있습니다:
  1. 원하는 경우, 계정을 생성하기 전에 ‘ IBM App Connect Enterprise Designer에서 HTTP 프록시 구성 만들기’에 설명된 대로 IBM App Connect Enterprise
    Designer에서 HTTP 프록시 구성을 생성할 수 있습니다.

  2. 플로우에 포함하려는 각 디자이너 커넥터에 대해 계정을 생성해야 애플리케이션에 연결할 수 있습니다. 가져온 REST API에 대한 계정을 생성하려면 계정 생성 단계에서 설명된 단계를 완료하거나 API용 흐름 생성에서 필요한 단계를 완료하십시오.

  3. API용 플로우 생성 방법에 대해 설명된 대로 API용 플로우를 생성하십시오.
  4. API 흐름 테스트 방법에 대해 설명된 대로 API 흐름을 테스트할 수 있습니다.
  5. 가져온 RESTAPI가 더 이상 필요하지 않은 경우 다음 단계를 완료하여 삭제할 수 있습니다:
    1. 사이드바 탐색 메뉴에서 연결 > 애플리케이션 및 API > 를 클릭하여 사용 가능한 커넥터 목록이 표시되는 애플리케이션 및 API 를 엽니다.
    2. 삭제하려는 RESTAPI를 선택하십시오. 예를 들어, TestingAPIforPets.
    3. "작업은 플로우가 완료하기를 원하는 작업입니다" 아래에서 '이 API 제거'를 클릭하세요.
    4. 메시지가 표시되면 제거를 클릭하십시오.
      가져온 REST API는 더 이상 플로우 생성 또는 계정 추가 시 표시되는 커넥터 목록에 나타나지 않습니다. 단계 7을 반복하여 삭제가 성공했는지 확인할 수 있습니다.