기존 WSDL 서비스에서 REST 프록시 API 작성

온라인에서 편집하기

WSDL 파일에 SOAP 서비스가 정의되어 있는 경우, WSDL 파일을 사용하여 해당 SOAP 서비스를 호출하는 API ConnectAI Gateway REST 프록시 API를 작성할 수 있습니다. 또한 WSDL 정의를 얻을 수 있는 위치로 연결되는 URL 링크를 제공할 수도 있습니다.

이 태스크에 대한 정보

API Designer UI 애플리케이션을 사용하거나 브라우저 기반 API Manager UI를 사용하여 이 태스크를 완료할 수 있습니다.

Draft comment: gb042610
Marking all content that relates to importing from a URL as Future, as this option has been deferred: https://github.ibm.com/velox/ui/issues/5878 JenD Mar2018

이 태스크를 완료하려면 Api-Drafts:Edit, Settings:View 및 App:View 권한이 있는 역할이 지정되어 있어야 합니다. 사전 제공된 개발자 역할에는 기본적으로 해당 권한이 있습니다. 사용자 정의 역할에 지정되는 경우 해당 권한이 있어야 합니다. 자세한 정보는 사용자 정의 역할 작성을 참조하십시오.

WSDL 파일이 외부 종속 항목이 없는 독립형 파일인 경우, 디렉토리에서 .wsdl 파일을 로드하여 REST API 정의를 작성할 수 있습니다.

WSDL 파일이 다른 WSDL 파일을 참조하거나 XML 스키마 정의를 포함하는 XSD 파일을 참조하는 경우, WSDL 파일 및 해당 종속 문서의 .zip 아카이브를 작성한 후 디렉토리에서 .zip 파일을 로드하여 REST API 정의를 추가해야 합니다.

URL 에서 WSDL 정의를 가져오려면, 대상 파일은 URL 에서 액세스할 수 있는 .wsdl 파일이어야 합니다. WSDL 파일과 그 종속 문서를 포함하는 파일은 .zip URL 에서 불러올 수 없습니다.

중요: 외부에서 접근할 수 IBM® API Connect 있으려면, 노출하는 서비스가 인터넷에서 공개 되어야 하며, 기업 내부 인트라넷 내에서만 접근할 수 있어서는 안 됩니다. 하지만 API Manager에서 구성된 TLS 프로필을 사용하여, IBM API ConnectIBM API ConnectIBM API Connect 내의 API Gateway 와 DMZ를 통해 인터넷에 노출된 서비스 간의 통신 채널을 보호할 수 있습니다. 또한 IBM Cloud ( Secure Gateway ) 서비스를 사용하여 외부에서 온프레미스 서비스에 안전하게 IBM API Connect 액세스할 수 있습니다. 자세한 내용은 ‘ Secure Gateway 정보’를 참조하십시오.

프로시저

WSDL 파일을 로드하여 REST API 정의를 추가하려면 다음 단계를 완료하십시오.
  1. 탐색 창에서 [개발 ]을 API UI 탐색 분할창의 개발 아이콘 클릭한 다음 [추가 ] > [API]를 클릭합니다.
    API 유형 선택 화면이 표시됩니다.
  2. OpenAPI 의 2.0 를 선택하세요.
  3. API 추가 분할창에서 기존 WSDL 서비스 (REST 프록시) 에서를 선택하십시오. 다음을 클릭하십시오.
    기존 WSDL 서비스(REST 프록시)에서 API 작성 창이 열립니다.
  4. 독립형 .wsdl 파일, WSDL 파일과 관련 문서를 포함하는 파일 .zip , 또는 레지스트리에서 서비스 정보를 업로드하려면 파일을 드래그 앤 드롭하거나, 사용하려는 파일을 찾아 선택하면 됩니다.
    Draft comment: gb042610
    There is no option to load from URL yet... so marking these choices as future. JenD Mar2018
    • ‘찾아보기’를 클릭한 다음 파일 .wsdl 또는 .zip 파일을 찾아보세요.
    • (.wsdl 파일만 해당) URL에서 로드를 클릭한 다음 WSDL URL 필드를 완료하십시오. URL을 보호하는 경우, URL 액세스를 위해 사용자 이름과 비밀번호를 제공해야 합니다.

    파일을 업로드한 후 WSDL이 평가되고 WSDL이 올바른지 여부를 나타내는 메시지가 표시됩니다.

    .zip 파일을 업로드하는 경우 추가 지시문을 지정하기 위한 옵션 파일을 .zip 파일에 포함할 수 있습니다. 자세한 내용은 ‘WSDL 서비스 가져오기 시 옵션 파일 사용’을 참조하십시오.

  5. 다음을 클릭하십시오. 서비스 선택 패널에서 가져온 파일로부터 WSDL 서비스를 선택하십시오.
  6. 다음을 클릭하십시오. 정보 섹션에서 API 요약을 지정하십시오. API가 작성된 후 미세 조정할 수 있습니다.
    • 제목은 특수 문자를 포함할 수 있지만 사용자 인터페이스에서 쉽게 표시할 수 있도록 짧게 유지해야 합니다.
    • 이름 이 자동으로 입력됩니다. 이름 필드의 값은 개발자 툴킷 CLI 명령에서 API를 식별하는 데 사용되는 단일 문자열입니다. 초안 API를 관리하는 CLI 명령어를 확인하려면 툴킷 CLI 참조 문서를 참조하십시오.
    • 버전 은 API OpenAPI 정의의 info.version 특성 값에 해당합니다. version.release.modification 버전 번호 지정 체계를 사용하는 것이 좋습니다(예: 1.0.0).
    • 기본 경로는 API의 URL 세그먼트이며 경로 또는 오퍼레이션에 대한 추가 세그먼트 또는 호스트 이름을 포함하지 않습니다. 기본 경로는 특수 문자를 포함할 수 없으며 / 문자로 시작해야 합니다. 경로가 비어 있는 경우에도 마찬가지입니다.
    • 선택적 설명은 API를 식별하는 데 도움이 됩니다.
  7. 다음을 클릭하십시오. 보안 섹션에서 사용자에게 필요한 API 보안을 구성하십시오.
    • 클라이언트 ID를 사용한 보안 설정 - 애플리케이션이 클라이언트 ID(API 키)를 제공하도록 요구하려면 이 옵션을 선택하십시오. 그러면 X-IBM-Client-Id 매개변수가 API의 요청 헤더에 포함됩니다. 선택된 경우, 각각의 키(각각의 클라이언트 ID) 기준으로 API 호출 수를 제한할지 여부를 선택할 수 있습니다.
      • 키 기준으로 API 호출 제한 - 선택된 경우 사용자에게 필요한 비율 한계를 구성해야 합니다. 비율 한계는 기간(시, 분, 월, 일) 내에 허용된 최대 호출 수를 제어합니다. 예를 들어 시간당 100개 호출입니다.
    • CORS - API에 대한 CORS(Cross-Origin Resource Sharing) 지원을 사용으로 설정하려면 이 옵션을 선택하십시오. 이 옵션을 사용하면 다른 도메인에서 API에 액세스할 수 있습니다.
      참고:
      • CORS 지원은 오직 에서만 가능합니다 DataPower® API Gateway.
      • CORS가 활성화되면 API Gateway는 cors 프리플로우 정책을 실행하여 API에 대한 모든 CORS 요청을 처리합니다.
      • CORS가 활성화되고 프리플라이트 요청이 수신되면 다음 API 조치만 수행됩니다.
        • cors 프리플로우 정책이 적절한 응답 헤더를 구성합니다.
        • 응답 헤더가 설정됩니다.
      • 프리플라이트 요청이 수신되면 request.attributes.isCORSPreflight 플래그가 true로 설정됩니다.
      • 모든 사전 실행 요청에 대해, ` CORS ` security 이 활성화되었는지 여부와 관계없이 ` client-identification preflow` 정책은 항상 건너뜁니다.
  8. 선택 사항: 추가 개발 및 테스트를 위해 API를 즉시 사용하려면 ‘API 활성화’를 선택하세요.
    참고:
    • API 활성화 옵션을 선택하면 API ConnectAI Gateway 가 자동으로 다음 조치를 완료합니다.
      • 초기 제품을 작성하고 API를 제품에 추가하고 API 호출이 가능하도록 제품을 샌드박스 카탈로그에 공개합니다. 제품의 제목은 api_title 자동 제품입니다. 이 제품은 개발 보기에 표시되지 않으며 직접 삭제할 수 없습니다. 단, API를 삭제하면 제품 초안도 API와 함께 삭제됩니다. 자세한 내용은 ‘API 정의 삭제’를 참조하십시오. 제품은 게시된 모든 카탈로그에 표시됩니다. 카탈로그에서 상품을 삭제하려면 별도로 처리해야 합니다. ‘카탈로그에서 상품 삭제’를 참조하세요
      • 테스트 환경에서 API를 즉시 테스트할 수 있도록 제품에 샌드박스 테스트 애플리케이션을 등록하십시오. API 테스트에 대한 정보는 API 테스트를 참조하십시오.
    • 스테이지(Stage), 게시(Publish) 또는 교체(Replace) 작업에 대해 샌드박스 카탈로그에서 라이프사이클 승인이 활성화된 경우, Activate API 옵션을 사용할 수 없습니다. 이러한 라이프사이클 승인 기능이 활성화된 경우, Activate API 옵션을 사용하려면 해당 기능을 비활성화해야 합니다. 라이프사이클 승인 설정에 대한 자세한 내용은 ‘카탈로그 생성 및 구성’을 참조하십시오.
    • API 활성화 옵션을 사용하려면 Product:Manage 및 Subscription:Manage 권한이 있는 역할이 지정되어야 합니다. 사전 제공된 개발자 역할에는 기본적으로 해당 권한이 있습니다. 사용자 정의 역할에 지정되는 경우 해당 권한이 있어야 합니다. 자세한 정보는 사용자 정의 역할 작성을 참조하십시오.
  9. 다음 을 클릭하여 API 정의를 작성하십시오.

    요약 패널이 정의가 작성되었다는 메시지를 표시하고 선택된 보안 옵션 및 비율 한계가 적용됩니다.

    API 활성화를 선택하면 마법사가 테스트에 사용할 수 있는 API 엔드포인트 URL 채웁니다. 클라이언트 ID를 사용하여 보안 설정을 선택한 경우에도 마법사는 사용자가 사용할 수 있는 클라이언트 ID 및 클라이언트 시크릿을 표시합니다.

  10. 다음 옵션 중 하나를 선택하십시오.
    • API를 추가 구성하려면 API 편집을 클릭하십시오. 세부사항은 API 정의 편집을 참조하십시오.
    • 현재 API를 추가로 구성하지 않으려면 이동 경로 추적에서 개발 링크를 클릭하여 시작 페이지로 돌아가십시오. 그런 다음 다른 태스크로 즉시 이동할 수 있습니다. 나중에 API를 구성하는 방법에 대한 세부사항은 API 정의 편집을 참조하십시오.

결과

기존 WSDL 파일을 사용하여 REST API 정의를 작성했습니다.

다음에 수행할 작업

API를 제품에 포함시키고 해당 제품을 카탈로그에 공개하면 애플리케이션 개발자가 API를 사용할 수 있게 됩니다. 자세한 내용은 ‘제품 작업’ 및 ‘카탈로그 작업’을 참조하십시오.

또한 API Designer UI의 API Designer UI 탐색 분할창의 관리 아이콘 ‘관리 ’ 페이지에서 해당 API와 연결된 샌드박스 카탈로그를 열어 제품 수명 주기를 관리하고, 누가 제품을 보고 구독할 수 있는지 제어할 수 있습니다.