처음부터 API에 대한 흐름 만들기

에서 API에 대한 흐름 ( API 플로우라고도 함)을 만들 수 있습니다 App Connect. 정의된 구성은 하나 이상의 작업을 노출하는 API를 제공합니다. 이러한 작업을 사용하여 엔드포인트를 호출하고 해당 엔드포인트와 흐름의 애플리케이션 간에 데이터를 전달할 수 있습니다.

시작하기 전에

  • 필요한 애플리케이션 또는 가져온 API를 알고 있는 경우 대상 애플리케이션 또는 API에 대해 API 작업을 실행하는 커넥터를 위한 App Connect 애플리케이션 및 API 페이지에서 대상 애플리케이션 또는 API에 대해 API 작업을 실행하는 커넥터에 대한 계정을 만드세요. 플로우를 만들 때 계정을 만들 수도 있습니다. 자세한 내용은 계정에 연결하기를 참조하세요.
  • 에서 관리할 수 있는 API 플로우를 만들기 위해 통합 저작을 사용하려면 API Connect 에서 관리할 수 있는 API 흐름을 만들려면 다음 요구 사항을 충족해야 합니다.
    • 액세스 권한이 있어야 합니다 API Connect 기능에 액세스해야 합니다 IBM® webMethods Hybrid Integration. 기능은 API Connect 기능과 동일한 환경에 있을 수도 있고 App Connect 기능 또는 다른 환경에 있을 수 있습니다. 또는 동일한 지역의 IBM API Connect Enterprise as a Service 인스턴스를 사용할 수도 있습니다 webMethods Hybrid Integration 환경의 인스턴스를 사용할 수도 있습니다. App Connect 홈페이지 에서 API Connect Enterprise as a Service 의 평가판 인스턴스를 프로비저닝하려면 IBM API Connect 사용하여 API 흐름 관리를 클릭합니다.
    • 귀하의 API Connect 인스턴스는 등록된 DataPower API Gateway 서비스로 하나 이상 구성해야 합니다.
    • 귀하의 API Connect 인스턴스에는 액세스 권한이 있는 공급자 조직이 하나 이상 포함되어 있어야 합니다. 공급자 조직에는 소유 소비자 조직과 클라이언트 ID가 있는 애플리케이션이 포함된 카탈로그가 포함되어 있어야 합니다.
    • 인스턴스에 대해 통합 저작을 사용 설정해야 합니다. API 플로우 편집기의 디자이너 탭에서 API 게이트웨이 설정 변경 아이콘( API 게이트웨이 설정 변경 아이콘)을 클릭하고 통합 작성을 사용 설정한 다음 저장을 클릭합니다. ( webMethods Hybrid Integration 환경에 API Connect 기능이 없거나 API Connect Enterprise as a Service 인스턴스가 webMethods Hybrid Integration 환경과 같은 지역에 있는 경우 API 게이트웨이 설정 변경 아이콘이 비활성화됩니다.)
      통합 작성 기능은 API 게이트웨이 설정에서 사용 설정할 수 있습니다.

이 태스크에 대한 정보

API에 대한 플로우를 만들 때 각 개별 플로우는 일반적으로 모바일 및 웹 애플리케이션에서 호출되는 API 작업에 대한 구현입니다. (작업의 예로는 'GET 주문' 및 'POST 주문'이 있습니다.) 각 작업의 흐름에는 요청, 하나 이상의 애플리케이션 또는 가져온 API에 대한 작업, API 작업에 대한 응답이 포함됩니다. 플로우에는 특수 데이터 처리를 위한 도구 상자 노드도 포함될 수 있습니다. 이 요청은 사용자가 정의한 모델을 사용하여 애플리케이션에서 데이터 개체의 생성, 검색 또는 교체를 요청합니다. 요청이 제출되면 각 대상 애플리케이션 또는 API가 해당 작업을 완료합니다. 그런 다음 플로우에서는 조치가 성공적이었음을 확인하거나 요청된 데이터를 리턴하는 응답을 리턴합니다.

API를 정의하는 데는 다음과 같은 높은 수준의 단계가 포함됩니다.
  1. 만들거나 검색하려는 개체의 구조를 정의하는 모델을 하나 이상 만듭니다. 최대 10개까지 모델을 만들 수 있습니다.
  2. 각 모델에 대해 완료할 기본 제공 생성, 검색, 바꾸기 또는 업데이트 작업을 선택하거나 사용자 지정 작업을 정의할 수 있습니다.
  3. 각 작업을 구현하는 플로우를 구성하고 하나 이상의 대상 애플리케이션 또는 API에 대한 작업을 추가합니다. 또한 이러한 애플리케이션의 입력 또는 출력 데이터를 처리하기 위해 도구 상자 유틸리티를 플로우에 추가할 수도 있습니다.
통합 저작:

인스턴스가 있는 경우 API Connect 인스턴스가 있는 경우 App Connect 인스턴스가 있는 경우, API를 둘 다 App ConnectAPI Connect. 이 기능을 통합 저작이라고 합니다. 통합 작성은 기본적으로 비활성화되어 있습니다.

통합 작성을 사용하면 다음에서 API 플로우를 만들고 시작하면 App Connect 에서 API 플로우를 생성하고 시작하면 API가 자동으로 제품에 추가됩니다. 그런 다음 해당 제품은 제공자 조직에 제공되는 카탈로그에 게시됩니다 API Connect. 카탈로그가 활성화된 사이트의 경우 제품은 API Connect 개발자 포털에도 표시됩니다. 게시 기본 설정은 로그인한 사용자를 기준으로 합니다. App Connect 사용자와 동일한 환경 또는 지역에 있는 API Connect 인스턴스와 동일한 환경 또는 지역에서 사용자가 액세스 권한이 있는 App Connect 인스턴스. 원하는 인스턴스 및 공급자 조직에 API를 게시하기 위한 설정을 지정할 수 있습니다 API Connect 인스턴스 및 공급자 조직에 게시하는 설정을 지정할 수 있습니다. 카탈로그 및 게이트웨이 대상, 게시된 API에 대한 포함 제품 및 요금제, 사용 애플리케이션을 선택할 수도 있습니다.

에서 API로 작업할 수 있습니다 API Connect 의 API와 독립적으로 App Connect. 개발자 포털에서 제품(및 API)을 찾아볼 수도 있습니다. 에서 API를 중지하면 App Connect 에서 API를 중지하면 API 관리자 사용자 인터페이스와 개발자 포털 사이트의 제품(및 API)이 자동으로 삭제됩니다. (액세스 권한이 없는 사용자는 API Connect 의 흐름을 중지할 수 있습니다 App Connect. 그러나 API는 여전히 API Connect.)

webMethods Hybrid Integration 에서 API Connect 기능 에 액세스할 수 있거나 App Connect 인스턴스와 동일한 지역에 있는 IBM API Connect Enterprise as a Service 인스턴스가 있는 경우 통합 작성을 활성화할 수 있습니다. 통합 작성 기능이 활성화되어 있고 API 플로우를 만들고 시작하면 플로우가 자동으로 API Connect. 게시 기본 설정을 지정하지 않고 API 플로우를 시작하면 검색된 인스턴스 중 샌드박스 카탈로그에 있는 자동 생성된 제품의 기본 플랜에 API가 게시됩니다 API Connect 인스턴스 중 하나에 있습니다.

의 API 편집기를 사용하여 App Connect 의 API 편집기를 사용하여 API 흐름을 생성하고 모델을 정의하고 API에 대한 작업을 구현할 수 있습니다. 또한 정책, 게이트웨이 및 포털 설정을 구성하여 API가 다음 위치에 게시될 때의 동작을 제어할 수도 있습니다 API Connect 에 게시될 때의 동작을 제어할 수도 있습니다. 다음 작업에서는 API 플로우를 만들고, 게시 기본 설정을 구성하고, 게시된 API에 액세스하는 방법을 설명합니다 API Connect.

에서 API 흐름 만들기 App Connect

프로시저

API 플로우를 만들려면 다음 단계를 완료하세요.

  1. App Connect 페이지에서 API에 대한 플로우 만들기를 클릭합니다.
    또는 디자인 페이지로 이동하세요. 디자인 페이지를 나타내는 아이콘 그런 다음 만들기 > API용 흐름을 클릭합니다.
    API 편집기는 세 개의 탭으로 열립니다.
    디자이너(Designer)
    디자이너 탭을 사용하여 API에 대한 모델과 작업을 만듭니다.
    OpenAPI
    탭을 사용하여 OpenAPI 탭을 사용하여 OpenAPI 3.0 사양을 준수하는 형식으로 API를 표시합니다.
    게이트웨이
    통합 저작이 활성화된 경우 게이트웨이 탭을 사용하여 게이트웨이가 게시된 API를 호출하는 데 사용할 수 있는 기본 설정을 확인합니다 API Connect. 이 API에 대해 추가 API 정책을 적용하거나 게이트웨이 및 포털 설정을 구성할 수도 있습니다.

    통합 저작이 비활성화되어 있는 경우 게이트웨이 탭에 활성화하는 지침이 제공됩니다.

  2. 선택 사항입니다: 통합 작성을 사용 설정하려면 디자이너 탭으로 이동하여 API 게이트웨이 설정 변경 API 게이트웨이 설정 변경 아이콘 을 클릭하고 통합 작성을 사용 설정한 다음 저장을 클릭합니다.
    통합 작성을 사용 설정하면 API 문서 게시에 대한 기본 설정을 확인하고 편집할 수 있습니다. 이러한 기본 설정은 15단계에 설명되어 있습니다.
  3. 흐름의 목적을 식별할 수 있는 이름을 입력합니다.
    API 편집기의 세 탭을 보여주는 스크린샷으로, 플로우 이름이 고객 API로 설정되어 있습니다.

    흐름을 진행하면서 App Connect 는 변경 사항을 자동으로 저장합니다. 흐름에서 벗어나면 흐름이 초안 흐름으로 저장되어 다른 시간에 완료할 수 있습니다.

  4. 작업하려는 객체의 구조를 정의하는 모델을 만들려면 모델 이름에 이름을 입력한 다음 모델 만들기를 클릭합니다.
    예를 들어 레코드를 생성, 검색 또는 업데이트할 수 있는 고객 개체가 필요할 수 있습니다.
    모델 패널에는 두 개의 탭이 있습니다.
    특성
    속성 탭을 사용하여 모델의 구조를 정의합니다.
    조작
    작업 탭을 사용하여 API가 모델과 상호 작용하는 방식을 정의합니다.
    속성 및 작업 탭이 있는 모델 패널
  5. 속성 탭에서 속성을 구성하여 모델의 구조를 정의합니다.
    참고: 속성에는 다음과 같은 요구 사항 및 제한 사항이 있습니다.
    • 각 속성 이름은 고유해야 합니다.
    • 이름에는 문자, 숫자 또는 밑줄 문자만 포함해야 합니다.
    • 이름에 공백은 허용되지 않지만 밑줄(_)을 사용하여 단어를 구분할 수 있습니다.
    • 이름은 문자 또는 밑줄로 시작해야 합니다.
    1. 첫 번째 속성을 추가하려면 이름을 입력하고 해당 속성에 대한 데이터 유형을 선택합니다.
      기본적으로 처음 추가하는 속성에는 ID 옵션이 선택되어 있습니다. 흐름은 객체를 생성할 때 모델의 ID로 지정된 프로퍼티를 반환해야 합니다. ID 속성은 ID를 사용하여 객체를 업데이트하거나 검색하려는 요청에도 전송되어야 합니다. 하나의 속성에 대해 ID를 설정합니다.
      팁: 연결된 애플리케이션에서 속성을 추가하려면 애플리케이션에서 속성 선택을 클릭할 수도 있습니다. 적절한 계정을 선택하고 하나 이상의 속성을 선택한 다음 속성 추가를 클릭합니다.
      애플리케이션에서 속성을 선택하는 대화 상자를 보여주는 스크린샷입니다. 연결된 HTTP 카운트가 선택되고 요청 속성 목록이 표시됩니다.
    2. 속성을 더 추가하려면 속성 추가를 클릭합니다.
      스크린샷은 고객 API 모델의 속성을 보여줍니다. CustomerID, FirstName, LastName, 및 이메일에 대한 문자열 유형 속성이 생성됩니다.
  6. 선택 사항입니다: 모델을 더 만들려면 모델 만들기를 클릭하고 각 새 모델에 대한 속성을 추가합니다.
    모델 이름을 편집하거나 모델을 삭제하려면 메뉴에서 해당 옵션을 사용합니다.
    스크린샷은 모델 정보 편집 및 모델 삭제 옵션이 포함된 모델 드롭다운 메뉴를 보여줍니다
  7. API가 모델과 상호 작용하는 방식을 정의하려면 작업을 클릭합니다.
    • 기본 제공 연산 중 하나를 추가하려면 추가할 연산 선택을 클릭한 다음 모델에 대해 실행할 만들기, 검색 또는 바꾸기 또는 만들기 연산을 선택합니다.
      추가할 작업 선택 메뉴의 옵션을 보여주는 스크린샷
    • 필터가 포함된 작업을 선택하는 경우 적절한 필터 속성을 선택합니다. 필터를 사용한 모델명 검색 작업의 경우 결과에 대한 페이지 매김 설정을 활성화하고 구성할 수도 있습니다. 페이지 매김을 사용하면 API가 실행될 때마다 데이터의 "페이지"를 반환할 수 있습니다. limit 매개변수는 반환할 레코드 수를 지정합니다. skip 매개변수는 흐름이 레코드를 반환하기 시작하기 전에 건너뛸 레코드 수를 지정합니다. token 매개변수는 API에서 레코드 반환을 시작할 위치를 식별하는 데 사용할 수 있는 문자열입니다.
      필터를 적용하려면 ID 속성은 필터로 선택할 수 없으므로 모델의 ID 속성을 포함하여 최소 두 개 이상의 속성을 정의해야 합니다.
      필터 작업이 있는 검색 모델의 필터 속성을 보여주는 스크린샷

      자세한 내용은 IBM App Connect 에서 API 흐름에 대한 필터 매개변수 소개 및 IBM Integration Community에서 API 흐름에서 필터를 사용하여 검색 작업에 대한 페이지 매김 구성을 참조하세요.

    • 고유한 작업을 정의하려면 추가할 작업 선택을 클릭한 다음 사용자 지정 작업 추가를 선택합니다.
      제한 사항: 쿼리 매개변수는 모델 ID와 동일할 수 없으며, 사용자 지정 작업의 이름은 다음 키워드 중 어느 것도 사용할 수 없습니다.

      create, updateOrCreate, replaceOrCreate, findOrCreate, buildNearFilter, all, destroyAll, count, save, update, destroy, delete, remove, replaceById, updateAttributes, patchAttributes, upsertWithWhere, getChangeModel, getIdName, getSourceId, handleChangeError, rectifyChange, replaceById, replaceOrCreate, replicate, updateAll, upsert, upsertWithWhere, destroy, fillCustomChangeProperties, getId, isNewRecord, reload, replaceAttributes, save, setId, updateAttribute, updateAttributes

  8. 작업을 구현하는 플로우를 구성합니다:
    1. 흐름 구현을 클릭합니다.
      작업 탭의 모델 옆에 있는 흐름 구현 버튼을 보여주는 스크린샷
      플로우 편집기에는 요청 노드, 응답 노드, 하나 이상의 대상 애플리케이션, 가져온 API 또는 도구 상자 유틸리티를 추가할 수 있는 공간이 포함된 기본 플로우 구조가 포함되어 있습니다. 요청 본문 예제의 구조는 모델의 프로퍼티와 몇 가지 샘플 데이터로 구성됩니다.
      플로우 편집기에서 API 플로우를 보여주는 스크린샷입니다. 플로우에는 요청 노드와 응답 노드가 포함되어 있으며 요청에 대한 샘플 콘텐츠가 표시됩니다
    2. 애플리케이션 또는 가져온 API를 플로우에 추가하려면 (+)를 클릭하고 애플리케이션 또는 API를 선택한 다음 적절한 작업을 선택합니다.
      올바른 계정을 선택했는지 확인합니다 App Connect 대상 애플리케이션 또는 API에 연결할 때 사용할 계정이 올바른지 확인합니다. 연결된 계정이 없는 경우 계정에 연결 하기의 안내에 따라 계정에 연결할 수 있습니다.
    3. 대상 애플리케이션 또는 API에 전달할 값으로 작업의 필드를 채웁니다. 정적 데이터를 일반 텍스트로 지정하거나 흐름의 이전 노드에서 매핑을 추가하여 동적 데이터를 지정할 수 있습니다. 함수(또는 JSONata 표현식)를 적용하여 데이터를 변환하거나 다른 기본 제공 메커니즘을 사용하여 사용자 지정 값을 정의할 수도 있습니다.

      텍스트, 매핑 및 JSONata 표현식을 수동으로 입력하거나 사용자 지정 값을 직접 정의하려면 작업 구성을 참조하세요.

      작업의 필드를 제안된 스마트 매핑으로 자동으로 채우려면 매핑 지원을 사용하세요( AI 기반 제안으로 데이터 매핑 및 데이터 변환 간소화하기 참조).
      스크린샷은 Salesforce 에서 연락처 만들기 작업의 완료된 매핑을 보여줍니다. Salesforce 작업의 계정 ID, 성 및 이름 속성은 각각 API 모델의 CustomerID, LastName, 및 FirstName 속성에 매핑됩니다.
      팁: 자동 생성 또는 사용자 지정 샘플 데이터를 사용하여 매핑을 추가할 때 테스트할 수 있습니다. 자세한 내용은 샘플 데이터로 매핑 테스트를 참조하세요. 작업의 필드를 완성한 후 샘플 데이터를 사용하여 작업을 테스트할 수도 있습니다. 작업을 테스트하려면 연결된 대상 애플리케이션에서 작업이 완료되므로 비프로덕션 계정을 사용 중인지 확인하세요. 자세한 내용은 샘플 데이터로 작업 테스트를 참조하세요.
    4. 선택 사항입니다: 추가 애플리케이션 또는 가져온 API를 추가합니다.
    5. 선택 사항입니다: 지원되는 하나 이상의 도구 상자 유틸리티를 사용하여 특수 처리를 제공합니다.
      예를 들어 조건부 처리를 제공하려면 If 노드를 추가하거나 검색된 항목을 처리하려면 For 각 노드를 추가합니다. 자세한 내용은 흐름에 특수 처리 추가하기(도구 상자 유틸리티) 를 참조하세요.
    6. 흐름에서 응답 노드를 클릭하여 작업이 성공적으로 완료될 때 반환되는 응답을 정의합니다.
    7. 응답 헤더 섹션에서 원하는 응답 상태 코드를 지정합니다.

      만들기 작업은 응답 코드 201(레코드가 생성됨)을 반환합니다.
      검색 작업은 응답 코드 200(레코드 검색됨)을 반환합니다.
      바꾸기 또는 만들기 작업은 응답 코드 200(레코드가 교체됨) 또는 201(레코드가 생성됨)을 반환합니다.

    8. 응답 본문 섹션에서 텍스트, 흐름의 이전 노드에서 매핑 또는 JSONata 표현식을 사용하여 응답 본문에 반환되는 필드를 정의합니다.
      API 작업의 CustomerID 속성을 다음의 연락처 ID 속성에 매핑하여 응답이 구성되었음을 보여주는 스크린샷입니다 Salesforce
      팁: 객체를 만들 때 일반적으로 대상 애플리케이션 또는 API의 ID만 응답 메시지에 반환됩니다. 객체를 검색하는 경우 응답 메시지에는 대상 애플리케이션 또는 API에서 요청한 모든 필드가 표시됩니다.

      플로우의 모든 노드를 구성한 후에는 자동 생성 또는 사용자 지정 샘플 데이터를 사용하여 플로우를 시작하기 전에 테스트할 수 있습니다. 플로우를 테스트할 때는 비프로덕션 계정을 사용해야 합니다. 흐름에서 구성된 작업은 연결된 대상 애플리케이션에서 완료됩니다. 자세한 내용은 샘플 데이터로 흐름 테스트를 참조하세요.

    9. 완료를 클릭하여 모델로 돌아갑니다.
  9. 모델에 대한 추가 작업을 정의하고 각 작업을 구현하는 흐름을 구성합니다.
    모델 생성, ID로 검색, 필터 모델로 바꾸기 또는 만들기 등 모델에 대한 여러 작업을 보여주는 스크린샷입니다
  10. 추가 모델에 대한 작업을 정의하고 해당 흐름을 구현하세요.
  11. 선택 사항: 오류 캐치 플로우를 추가하여 API 플로우에서 오류를 처리할 수 있습니다.
  12. 플로우를 테스트하거나 배포하기 전에 플로우의 유효성 검사 오류를 수정하세요.
    자세한 내용은 플로우 유효성 검사를 참조하세요.
  13. 선택 사항입니다: 흐름에 대한 API 정의를 보려면 OpenAPI 탭을 클릭합니다.
    API 정의는 양식 보기( 양식 아이콘)에 표시되며, 이는 API를 편집하는 보기와 유사합니다 API Connect. 이 탭의 세부 정보는 읽기 전용이지만 API 편집기에서 흐름의 모델과 작업을 변경하면 자동으로 업데이트됩니다. 양식 보기의 일반 카테고리는 기본적으로 확장되어 있습니다. 다음 카테고리도 사용할 수 있습니다. (이 보기의 일부 섹션은 현재 적용되지 않거나 API에 대한 세부 정보가 표시되지 않습니다.)
    구성 요소 카테고리에는 API 정의의 다양한 측면과 관련된 재사용 가능한 객체가 표시됩니다.
    • 스키마는 각 모델 및 해당 속성에 대한 세부 정보를 표시합니다.
    • 응답이 적용되지 않습니다.
    • 매개변수는 적용되지 않습니다.
    • 예제는 적용되지 않습니다.
    • 요청 기관은 해당되지 않습니다.
    • 헤더는 적용되지 않습니다.
    • 보안 체계에는 API 작업을 호출할 때 자격 증명(클라이언트 ID)을 제공하는 데 사용되는 사전 구성된 API 키 보안 체계에 대한 세부 정보가 표시됩니다. 보안 체계 이름은 apiKey 유형으로 clientID 으로 지정되며, X-IBM-Client-Id 매개 변수는 API의 요청 헤더에 자격 증명을 전달하는 데 사용됩니다.
    • 링크는 적용되지 않습니다.
    OpenAPI 탭의 구성 요소 섹션
    일반 카테고리에는 다음 섹션이 포함되어 있습니다.
    • 정보 섹션에는 API 요약이 포함되어 있습니다. 이 섹션에는 제목으로 플로우 이름, 플로우 이름을 기반으로 생성되고 API를 식별하는 데 사용되는 이름, 할당된 버전(일반적으로 0.0.1 )이 포함됩니다. 나머지 필드는 비어 있습니다.
    • 서버 섹션에는 대상 서버에 연결하기 위한 API의 서버 정의가 표시됩니다. API를 테스트할 때 API는 기본 통합 런타임에 임시로 배포됩니다. 따라서 API 엔드포인트는 https://default-integration-runtime;로 시작합니다(예: ):
      https://default-integration-runtime-https-ac0abcd2def.p-vir-d1.appconnect.ibmappdomain.cloud/Bookstore_API
      API를 배포하면 API는 생성한 런타임에 배포됩니다. 따라서 API 엔드포인트는 런타임의 이름으로 시작됩니다(예: 런타임 이름):
      https://my-custom-ir-https-ac0abcd2def.p-vir-d1.appconnect.ibmappdomain.cloud/Bookstore_API
      API의 서버 섹션에는 기본 통합 런타임의 API에 대한 URL 서버가 표시됩니다.
    • 보안은 API에 적용되는 보안 요구 사항을 표시합니다. 기본적으로 apiKey 유형의 clientID 보안 체계가 구성되어 있습니다.
    • 외부 문서는 적용되지 않습니다.
    • 태그는 적용되지 않습니다.
    OpenAPI 탭의 일반 섹션
    경로 카테고리에는 API 플로우에 정의된 각 작업에 대한 경로가 표시됩니다. 각 경로는 HTTP 동사와 URL (상대) 경로로 구성되며 API가 노출되는 방식을 정의합니다. 탐색 창에서 각 URL 경로를 클릭하여 확장하여 자세히 살펴볼 수 있습니다. 이 카테고리에는 다음 섹션이 포함되어 있습니다.
    • 서버는 해당되지 않습니다.
    • 매개변수는 적용되지 않습니다.
    • 작업에는 작업 유형에 따른 세부 정보가 표시됩니다. 예를 들어 태그(모델 이름에 해당), 경로 또는 쿼리 매개변수, 응답 코드 및 설명이 표시될 수 있습니다.
    경로 섹션의 OpenAPI 탭
    소스 소스 아이콘 를 클릭하면 UI에서 API 정의에 대한 기본 OpenAPI YAML 소스를 볼 수 있습니다. 이 보기는 읽기 전용이며, YAML 소스는 OpenAPI 3.0 사양을 준수합니다.
    API 정의에 대한 소스 보기
  14. 선택 사항: 통합 저작이 활성화된 경우 게이트웨이 탭을 클릭하여 정책과 게이트웨이 및 포털 설정을 보고 구성합니다. 여기에서 구성하는 모든 설정은 다음에 게시된 API의 동작에 영향을 주지만 API Connect 에서 실행되는 API에는 영향을 미치지 않지만 App Connect.

    통합 저작이 비활성화된 경우 16단계로 이동하여 흐름을 시작합니다.

    정책
    이 보기를 사용하여 어셈블리 편집기를 확인하고 어셈블리를 생성하여 API를 사용자 지정할 수 있습니다. 어셈블리는 API의 작업 호출 및 응답에 적용되는 요소(예: 정책 또는 논리 구성)로 구성됩니다. 어셈블리 편집기에는 사용 가능한 요소를 나열하는 팔레트가 포함되어 있습니다. 또한 요소를 구성하는 데 사용되는 슬라이드 아웃 속성 시트와 어셈블리의 요소를 정렬하고 시각화하는 데 사용되는 캔버스도 포함되어 있습니다. 자세한 내용은 어셈블리 편집기, API 정책 및 로직 구성, 어셈블리에서 오류 처리하기 문서를 참조하세요 API Connect 문서를 참조하세요.
    정책 보기의 어셈블리 편집기
    정책 보기를 처음 열면 캔버스에 API를 실행하기 위한 단일 Invoke 정책이 제공됩니다. 게이트웨이는 이 정책을 사용하여 실행 중인 API를 App Connect. 클릭하여 이 정책의 속성 시트를 열 수 있습니다. 그러나 HTTP 기본 인증에 대한 사용자 아이디와 비밀번호가 포함된 기본 설정은 수정할 필요가 없습니다. 필드의 app-connect-designer-url 변수는 URL 필드의 URL 변수는 게이트웨이가 액세스해야 하는 현재 App Connect 인스턴스를 나타내며, 게이트웨이가 액세스해야 합니다. 이 URL 는 게이트웨이 탭의 게이트웨이 및 포털 설정 > 속성에서 정의됩니다.
    참고: 기본 Invoke 정책(제목: Invoke flow)을 삭제하지 마세요 App Connect 엔드포인트 URL 에 액세스하는 대체 방법을 고안하지 않는 한 삭제하지 마세요. app-connect-designer-url 은 URL 엔드포인트를 정의합니다.
    속성 시트에서 플로우 정책 기본 설정 호출하기
    팔레트에서 요구 사항에 맞게 다른 정책이나 논리적 구성을 추가할 수 있습니다. 예를 들어 API 호출을 제한하려면 Rate limit 정책을 어셈블리의 올바른 위치로 드래그하면 됩니다. 그런 다음 속성 시트를 사용하여 지정된 기간 동안 허용되는 최대 통화 횟수를 정의할 수 있습니다. 자세한 내용은 API Connect 문서에서 요금 한도를 참조하세요.
    팁: 어셈블리에 요금 제한이 정의되어 있으면 어셈블리의 해당 지점에서만 호출에 영향을 미칩니다. 플랜에서 호출을 진행하도록 허용하지만 어셈블리에 설정된 하드 제한이 초과되면 프로세스 흐름에서 속도 제한이 설정된 지점에서 호출이 중지됩니다. 속도 제한 정책이 완료되기 전에 어셈블리의 프로세스 흐름에 표시되는 모든 작업. 속도 제한 정책 이후 흐름에 표시되는 작업만 취소됩니다.
    어셈블리 편집기 캔버스의 요금 제한 정책
    게이트웨이 및 포털 설정
    이 패널을 사용하여 API의 일반 구성 설정을 보고 이러한 설정 중 일부를 업데이트할 수 있습니다. 자세한 내용은 게이트웨이 및 포털 설정 지정하기 문서를 참조하세요 API Connect 문서를 참조하세요.
    게이트웨이 및 포털 설정 섹션
    팁: 기본 app-connect-designer-url 속성( 게이트웨이 및 포털 설정 > 속성 아래)은 현재 인스턴스의 URL 을 정의합니다 App Connect 인스턴스를 정의하며, 게이트웨이가 액세스에 사용합니다. 이 속성을 삭제하거나 수정하지 마세요.
    게이트웨이 및 포털 설정 섹션
  15. 선택 사항: 통합 저작이 활성화된 경우 API Connect 에 대한 게시 환경 설정을 구성합니다

    통합 저작이 비활성화된 경우 16단계로 이동하여 흐름을 시작합니다.

    흐름이 중지된 경우에만 게시 환경설정을 구성하거나 업데이트할 수 있습니다. 게시 환경 설정은 해당 흐름에만 연결됩니다.

    해당 플로우에 대한 게시 환경설정을 먼저 설정하지 않고 API 플로우를 시작하면 플로우에 대해 저장된 마지막 사용자 환경설정 집합이 사용됩니다. 이전에 기본 설정이 설정되지 않은 경우, API는 검색된 인스턴스의 샌드박스 카탈로그에서 자동 생성된 제품의 기본 플랜에 게시됩니다 API Connect 인스턴스.

    1. API 편집기의 디자이너 탭에서 API 게이트웨이 설정 변경 아이콘 API 게이트웨이 설정 변경 아이콘 을 클릭합니다.
      API 편집기에서 환경설정 아이콘의 위치
      API 게이트웨이 설정 패널이 열립니다.
      API 게이트웨이 설정 패널 스크린샷
      참고: API 흐름을 API Connect 에 자동으로 게시하지 않으려면 이 패널에서 통합 작성 기능을 비활성화할 수 있습니다. 흐름이 시작된 후 실행되는 동안에는 통합 작성을 비활성화하거나 다른 환경설정을 업데이트할 수 없습니다. 선택한 환경설정은 읽기 전용 모드에서 볼 수 있지만, 이러한 환경설정을 업데이트하려면 플로우를 중지해야 합니다. 플로우를 중지하면 게시된 API가 삭제됩니다. 플로우를 다시 시작하면 업데이트된 기본 설정에 따라 API가 다시 게시됩니다.
    2. 스테이징 대상 및 런타임 설정에서 편집 링크를 사용하여 제품(및 API)을 게시할 수 있는 스테이징 대상과 게시된 API를 호스팅하는 게이트웨이 서비스를 정의합니다.
      대상 카탈로그

      API가 포함된 제품을 게시할 카탈로그를 지정합니다. 선택한 카탈로그는 다른 환경설정 설정의 범위로 사용됩니다. API 카탈로그가 표시되며 API Connect 기능과 동일한 환경에서 App Connect 기능에 대해 표시됩니다. 다른 환경의 카탈로그에서 카탈로그를 선택하려면 API Connect 기능에서 카탈로그를 선택하려면 기타 환경을 클릭합니다. 인스턴스에서 API 카탈로그를 검색하려면 API Connect Enterprise as a Service 인스턴스에서 API 카탈로그를 찾으려면 webMethods Hybrid Integration 인스턴스와 동일한 지역의 인스턴스에서 API 카탈로그를 찾으려면 기타 환경 탭으로 이동하여 외부 검색을 클릭합니다.

      대상 공간
      선택한 카탈로그가 스페이스로 분할되어 있는 경우 게시할 스페이스를 지정합니다.
      참고: 기본 제공 샌드박스 카탈로그를 사용하도록 선택한 경우 이 카탈로그에 스페이스를 사용할 수 없으므로 대상 스페이스 옵션이 표시되지 않습니다. 스페이스로 파티션되지 않은 기존 카탈로그를 선택한 경우 대상 스페이스 옵션도 표시되지 않습니다.
      대상 게이트웨이 서비스
      게시된 제품 및 API에 대한 수신 트래픽을 처리하기 위한 런타임 기능을 제공하는 게이트웨이 서비스를 지정합니다. 일반적으로 datapower-api-gateway 게이트웨이 유형이 검색된 게이트웨이 서비스만 호환되는 것으로 간주됩니다.
      • 호환되는 모든 게이트웨이 서비스 사용: 검색된 모든 호환 가능한 게이트웨이 서비스를 사용하려면 이 옵션을 클릭합니다.
      • 호환되는 게이트웨이 서비스를 선택합니다: 호환 가능한 게이트웨이 서비스를 하나 이상 선택하려면 이 옵션을 클릭합니다. (호환되지 않는 게이트웨이 유형은 비활성화됩니다.)
      카탈로그, 스페이스 및 게이트웨이의 설정 예시
    3. API 소비 설정에서 편집 링크를 사용하여 소비자를 위한 API 패키징 방법을 정의하고 API 사용을 관리합니다.
      대상 제품
      API를 포함할 제품을 지정합니다.
      • 자동 제품 생성: 자동 생성된 제품을 사용하려면 이 옵션을 클릭합니다. 이 제품의 이름은 API 게이트웨이 설정 패널에서 API title auto product 로 표시되며, 여기서 API 제목은 플로우 이름을 나타냅니다. (이 이름은 나중에 설명하는 API Connect 인스턴스에서는 다릅니다.)
      • 기존 제품: 선택한 카탈로그에서 기존 제품을 선택하려면 이 옵션을 클릭합니다.
      대상 제품 비율 한계
      자동 생성된 제품에 게시하도록 선택한 경우 API 호출을 제어하기 위해 속도 제한을 구성합니다. 이 요금 한도는 자동 생성된 제품의 기본 요금제에 적용되며, 요금제 내의 모든 운영에 걸쳐 공유됩니다.
      • 무제한: 무제한 통화를 허용하려면 이 옵션을 클릭합니다.
      • 사용자 지정: 이 옵션을 클릭하면 일정 기간 동안 지정된 통화 횟수를 정의할 수 있습니다.

      기존 제품을 선택한 경우 대상 제품 요금 제한 옵션이 비활성화됩니다. 대신 선택한 제품 및 요금제에 구성된 요금 제한이 적용됩니다.

      팁: API 흐름의 게이트웨이 탭을 사용하여 API 어셈블리 흐름의 어느 지점에서나 Rate Limit 정책을 추가하여 API 어셈블리에서 보다 세분화된 속도 제한을 정의할 수도 있습니다.
      대상 플랜

      기존 제품을 선택한 경우, 선택한 애플리케이션이 구독하고 API를 사용할 수 있는 관련 요금제를 선택합니다.

      자동 생성된 제품에 게시하도록 선택한 경우 애플리케이션은 이 제품의 기본 요금제에 자동으로 가입되며 이 설정은 변경할 수 없습니다.

      테스트 애플리케이션
      선택한 요금제에 가입하여 API를 사용하려는 애플리케이션을 선택합니다.
      • 기본 제공 테스트 애플리케이션 사용: 미리 제공된 테스트 애플리케이션을 사용하려면 이 옵션을 선택합니다. 이 옵션은 샌드박스 카탈로그를 사용하도록 선택한 경우에만 사용할 수 있습니다.
      • 기존 애플리케이션을 선택합니다: 선택한 카탈로그에서 수동으로 생성한 기존 애플리케이션을 선택하려면 이 옵션을 선택합니다. (개발자 포털 사이트가 있는 경우 이 애플리케이션은 선택한 카탈로그와 연결된 포털에 등록됩니다.)
      테스트 이용자 조직

      선택한 애플리케이션을 소유한 소비자 조직이 기본적으로 여기에 표시됩니다.

      제품, 요금제 및 애플리케이션에 대한 설정 예시
    4. 저장을 클릭하여 설정을 저장합니다.
      게시 기본 설정은 흐름이 유지되는 동안 유지됩니다 App Connect. 기본 설정은 API를 중지했다가 다시 시작하거나 통합 저작을 비활성화했다가 다시 활성화하는 경우에도 유지됩니다.
  16. 흐름을 실행하여 동작을 관찰할 수 있습니다.

결과

귀하의 API는 디자인 페이지에 타일 형태로 표시됩니다. 타일을 사용하여 API를 관리할 수 있습니다. API를 관리하는 데 사용할 수 있는 옵션은 요금제와 API 상태에 따라 다릅니다. 자세한 내용은 개발 중 흐름 관리 항목을 참조하십시오.

다음에 수행할 작업

  • API를 배포하기 전에 API의 동작을 테스트할 수 있습니다. 자세한 내용은 API 테스트를 참조하세요.
    참고: 통합 작성 기능이 활성화되어 있고 해당 흐름에 대한 게시 환경설정을 설정하기 전에 흐름을 시작하면 흐름에 대해 저장된 마지막 사용자 환경설정 세트가 사용됩니다. 이전에 기본 설정이 설정되지 않은 경우, API는 검색된 인스턴스의 샌드박스 카탈로그에서 자동 생성된 제품의 기본 플랜에 게시됩니다 API Connect 인스턴스. 따라서 API가 게시되는 위치를 제어하려면 API를 시작하기 전에 원하는 설정을 지정해야 합니다.
    API를 테스트할 때 API 편집기에서 테스트 탭을 사용할 수 있습니다.
    API 테스트 탭의 개요 페이지
    실행 중인 API 흐름에 대한 OpenAPI 3.0 YAML 정의는 App Connect 인스턴스의 지정된 카탈로그 및 공급자 조직에 있는 제품 및 플랜에 API를 자동으로 게시하는 데 사용됩니다 API Connect 인스턴스. 개발자 포털을 구성한 경우 API 제품도 개발자 포털에 표시됩니다.
    참고: 통합 저작이 활성화되어 있으면 기본 설정에 따라 API가 자동 생성된 제품 또는 선택한 기존 제품의 독립 실행형 버전에 추가됩니다. 게시된 제품에는 API만 포함되어 있습니다.
  • 프로덕션 환경에서 플로우를 실행할 준비가 되면 배포하세요. 자세한 내용은 통합 배포하기를 참조하세요.

에서 게시된 API에 액세스하기 API Connect

이 태스크에 대한 정보

통합 저작이 활성화된 경우 API가 실행 중일 때 인스턴스에 액세스하여 API Connect 인스턴스에 액세스하여 API 관리자 및 개발자 포털에서 게시된 API를 볼 수 있습니다.
팁: 귀하의 App Connect API가 API Connect 에 표시되지 않고 얼마 전에 통합 작성을 활성화했다면 통합 작성을 비활성화하고 변경 내용을 저장한 다음 다시 활성화하세요.

프로시저

에서 API에 액세스하려면 API Connect 에서 API에 액세스하려면 다음 단계를 완료하세요.

  1. API Connect 인스턴스에서 API 관리자 UI를 엽니다.
  2. 탐색 창에서 관리 아이콘 관리 아이콘 을 클릭합니다.
  3. 관리 페이지에서 게시하도록 선택한 샌드박스 또는 사용자 정의 카탈로그를 선택합니다.
    제품 탭에서 API가 포함된 게시된 제품을 확인할 수 있습니다. 제품 제목과 이름은 원래 API 흐름의 이름에서 파생되며, 또한 App Connect. 자동 생성된 제품에 게시하도록 선택한 경우 제품 버전은 0.0.1 으로 지정됩니다. 기존 제품의 독립 실행형 버전에 게시하도록 선택한 경우 제품 버전이 상속됩니다.
    • 자동 생성된 제품에 게시하도록 선택한 경우 제품 제목은 API_flow_name (Created by App Connect Designer) 으로 표시되고 이름은 api-flow-name-created-by-app-connect-designer 으로 표시됩니다.
    • 기존 제품에 게시하도록 선택한 경우 제품 제목은 Product name - API_flow_name (Created by App Connect Designer) 으로 표시되고 이름은 product-name-api-flow-name-created-by-app-connect-designer 으로 표시됩니다.
    API 관리자 UI에 게시된 API
  4. 선택 사항: API로 작업하려면(제한된 용량으로) 옵션 아이콘( 옵션 아이콘 )을 클릭하고 적절한 메뉴 옵션을 선택합니다.
    예를 들어 API 관리를 선택하여 API의 기본 엔드포인트를 보거나 구독을 볼 수 있습니다. 애널리틱스 탭을 사용하여 API 호출에 대한 애널리틱스를 볼 수도 있습니다.
    제한 사항: API는 더 이상 개발할 수 없으며 API Connect 에서 해당 API가 실행되는 동안에만 API 관리자 UI에 존재하며 App Connect 가 실행 중일 때만 가능합니다. 에서 API를 중지하면 App Connect 에서 API를 중지하면 제품이 카탈로그에서 자동으로 삭제됩니다.
  5. 선택 사항: 지정된 카탈로그에 대해 활성화된 개발자 포털에 액세스할 수 있는 경우 포털 URL (API 관리자의 카탈로그 설정 아래)을 사용하여 개발자 포털 사이트를 엽니다.
    API 관리자 UI의 샌드박스 카탈로그 설정에서 포털( URL )을 찾습니다
    개발자 포털에서 API 제품을 클릭하여 게시된 API 제품을 살펴봅니다.
    개발자 포털에 게시된 제품 및 API
    타일에서 제품 이름 또는 API 이름을 클릭하여 요금제 세부 정보 또는 API의 OpenAPI 정의를 보거나 API를 테스트할 수 있습니다.
    OpenAPI 개발자 포털에서 API 정의

    자세한 내용은 개발자 포털에서 API 및 제품 탐색하기를 참조하세요 API Connect 문서를 참조하세요.

    제한: API 제품은 개발자 포털에 있는 해당 API가 App Connect 실행 중일 때만 존재합니다. 에서 API를 중지하면 App Connect 에서 API를 중지하면 API 제품이 포털에서 자동으로 제거됩니다.