API로 SAP OData 메타데이터 가져오기

적용 대상: 모든 API Management 계층

이 문서에서는 메타데이터 설명을 사용하여 OData 서비스를 가져오는 방법을 보여 줍니다. 이 문서에서는 SAP Gateway Foundation를 예로 사용합니다.

이 문서에서는 다음을 수행합니다.

• SAP 서비스에서 OData 메타데이터 검색
• OData 메타데이터를 직접 또는 OpenAPI 사양으로 변환한 후 API Management로 가져오기
• API 구성 완료
• Azure Portal에서 API 테스트

필수 조건

• 기존 API Management 인스턴스. 구독이 아직 없다면 하나를 만듭니다.

• OData v2 또는 v4로 공개된 SAP 시스템 및 서비스

• SAP 백 엔드에서 테스트 목적으로 자체 서명된 인증서를 사용하는 경우 SSL에 대한 신뢰 체인 확인을 사용하지 않도록 설정해야 할 수 있습니다. 이렇게 하려면 API Management 인스턴스에서 백 엔드를 구성합니다.

  1. Azure Portal의 API 아래에서 백 엔드>+ 추가를 차례로 선택합니다.
  2. SAP 백 엔드 서비스를 가리키는 사용자 지정 URL을 추가합니다.
  3. 인증서 체인 유효성 검사 및 인증서 이름 유효성 검사를 선택 취소합니다.

  참고 항목

  프로덕션 시나리오의 경우 엔드투엔드 SSL 확인에 적절한 인증서를 사용합니다.

SAP 서비스에서 OData 메타데이터 검색

다음 방법 중 하나를 사용하여 SAP 서비스에서 메타데이터 XML을 검색합니다. 메타데이터 XML을 OpenAPI 사양으로 변환하려는 경우 파일을 로컬로 저장합니다.

• SAP Gateway 클라이언트(트랜잭션 /IWFND/GW_CLIENT)를 사용합니다. 또는
• 직접 HTTP(http://<OData server URL>:<port>/<path>/$metadata)를 호출하여 XML을 검색합니다.

API Management 인스턴스로 이동

1. Azure Portal에서 API Management 서비스를 검색하여 선택합니다.

   

2. API Management 서비스 페이지에서 API Management 인스턴스를 선택합니다.

   

API Management로 API 가져오기

API를 API Management로 가져오려면 다음 방법 중 하나를 선택합니다. 메타데이터 XML을 OData API로 직접 가져오거나 메타데이터 XML을 OpenAPI 사양으로 변환합니다.

OData 메타데이터

OData 메타데이터 가져오기

1. 왼쪽 메뉴에서 API>+ API 추가를 선택합니다.

2. 정의에서 만들기에서 OData를 선택합니다.

   

3. API 설정을 입력합니다. 나중에 API의 설정 탭으로 이동하여 설정을 업데이트할 수 있습니다.

   1. OData 사양에서 OData 메타데이터 엔드포인트에 대한 URL(일반적으로 서비스 루트에 대한 URL)을 입력하고 /$metadata를 추가합니다. 또는 가져올 로컬 OData XML 파일을 선택합니다.

   2. 나머지 설정을 입력하여 API를 구성합니다. 이러한 설정은 첫 번째 API 가져오기 및 게시 자습서에 설명되어 있습니다.

4. 만들기를 실행합니다.

   API가 API 목록에 추가됩니다. OData 메타데이터 설명에 노출되는 엔터티 집합 및 함수는 API의 엔터티 집합 및 함수 탭에 표시됩니다.

   

OData 스키마 업데이트

포털에서 편집기에 액세스하여 API의 OData 스키마를 볼 수 있습니다. API가 변경되면 파일 또는 OData 서비스 엔드포인트에서 API Management의 스키마를 업데이트할 수도 있습니다.

1. 포털에서 API Management 인스턴스로 이동합니다.

2. 왼쪽 메뉴에서 API> OData API를 선택합니다.

3. 엔터티 집합 및 함수 탭에서 엔터티 집합 또는 함수 옆에 있는 바로 가기 메뉴(...)를 선택하고 편집을 선택합니다.

   

4. 스키마를 검토합니다. 업데이트하려면 파일에서 업데이트 또는 엔드포인트에서 스키마 업데이트를 선택합니다.

   

OData API 테스트

1. 왼쪽 메뉴에서 API> OData API를 선택합니다.

2. 엔터티 집합 및 함수 탭에서 엔터티 집합 또는 함수 옆에 있는 바로 가기 메뉴(...)를 선택하고 테스트를 선택합니다.

   

3. 테스트 콘솔에서 테스트에 대한 템플릿 매개 변수, 쿼리 매개 변수 및 헤더를 입력하고 테스트를 선택합니다. 포털에서 API 테스트에 대해 자세히 알아봅니다.

OData API 보호

OData API 요청을 통한 공격으로부터 보호하기 위해 기존 인증 및 권한 부여 정책 및 OData 유효성 검사 정책을 모두 적용하여 OData API를 보호합니다.

팁

포털의 API 정책 탭에서 OData API에 대한 정책을 구성합니다.

OpenAPI 사양

OData 메타데이터를 OpenAPI JSON으로 변환

1. OData XML을 OpenAPI JSON 형식으로 변환합니다. 메타데이터 XML에 따라 OData v2 또는 OData v4용 OASIS 오픈 소스 도구를 사용합니다.

   다음은 epm_ref_apps_prod_man_srv 테스트 서비스에 대해 OData v2 XML을 변환하는 명령의 예제입니다.

   odata-openapi -p --basePath '/sap/opu/odata/sap/epm_ref_apps_prod_man_srv' \
    --scheme https --host <your IP address>:<your SSL port> \
    ./epm_ref_apps_prod_man_srv.xml
   

   참고 항목

   • 단일 XML 파일을 사용하여 테스트하기 위해 오픈 소스 도구를 기반으로 하는 웹 기반 변환기를 사용할 수 있습니다.
   • 도구 또는 웹 기반 변환기를 사용하는 경우 SAP OData 서버의 <IP 주소>:<포트>를 지정하는 것은 선택 사항입니다. 또는 이 정보를 나중에 생성된 OpenAPI 사양에 추가하거나 API Management로 가져온 후에 추가합니다.

2. API Management로 가져오기 위해 openapi-spec.json 파일을 로컬로 저장합니다.

백 엔드 API 가져오기 및 게시

1. 측면 탐색 메뉴의 API 섹션 아래에서 API를 선택합니다.

2. 새 정의 만들기 아래에서 OpenAPI 사양을 선택합니다.

   

3. 파일 선택을 클릭하고, 이전 단계에서 로컬로 저장한 openapi-spec.json 파일을 선택합니다.

4. API 설정을 입력합니다. 생성 중에 값을 설정하거나 나중에 설정 탭으로 이동하여 값을 설정할 수 있습니다.

   • API URL 접미사에서 원본 SAP 서비스에서와 동일한 URL 경로를 사용하는 것이 좋습니다.

   • API 설정에 관한 자세한 내용은 첫 번째 API 가져오기 및 게시 자습서를 참조하세요.

5. 만들기를 선택합니다.

참고 항목

API 가져오기 제한 사항은 다른 문서에 설명되어 있습니다.

API 구성 완료

다음 세 가지 작업을 가져온 API에 추가합니다.

• GET /$metadata

  연산	설명	작업에 대한 추가 구성
  GET /$metadata	API Management에서 OData 서버와의 클라이언트 통합에 필요한 $metadata 엔드포인트에 도달할 수 있도록 합니다. 이 필수 작업은 생성하고 가져온 OpenAPI 사양에 포함되지 않습니다.	200 OK 응답을 추가합니다.

  

• HEAD /

  연산	설명	작업에 대한 추가 구성
  HEAD /	필요한 경우 클라이언트에서 CSRF(교차 사이트 요청 위조) 토큰을 SAP 서버와 교환할 수 있도록 합니다. SAP는 GET 동사를 사용한 CSRF 토큰 교환도 허용합니다. CSRF 토큰 교환은 이 문서에서 설명하지 않습니다. 토큰 교환을 조정하는 API Management 정책 코드 조각의 예제를 참조하세요.	해당 없음

  

• GET /

  연산	설명	작업에 대한 추가 구성
  GET /	서비스 루트에서 정책 구성을 사용하도록 설정합니다.	후행 슬래시를 서비스 루트로 전달되는 요청에 추가하도록 다음 인바운드 rewrite-uri 정책을 구성합니다. <rewrite-uri template="/" copy-unmatched-params="true" /> 이 정책은 일부 백 엔드에서 다르게 처리되는 후행 슬래시의 유무에 관계없이 요청의 잠재적 모호성을 제거합니다.

  

또한 환경에 적절한 방법을 사용하여 백 엔드에 대한 인증을 구성합니다. 예를 들어 API Management 인증 및 권한 부여 정책을 참조하세요.

API 테스트

1. API Management 인스턴스로 이동합니다.

2. 측면 탐색 메뉴의 API 섹션 아래에서 API를 선택합니다.

3. 모든 API 아래에서 가져온 API를 선택합니다.

4. 테스트 탭을 선택하여 테스트 콘솔에 액세스합니다.

5. 작업을 선택하고, 필요한 값을 입력한 다음, 보내기를 선택합니다.

   예를 들어 GET /$metadata 호출을 테스트하여 SAP 백 엔드에 대한 연결을 확인합니다.

6. 응답을 봅니다. 문제를 해결하려면 호출을 추적합니다.

7. 테스트가 완료되면 테스트 콘솔을 종료합니다.

프로덕션 고려 사항

• API Management를 SAP Gateway와 통합하는 엔드투엔드 시나리오 예제를 참조합니다.
• API Management 정책을 사용하여 SAP 백 엔드에 대한 액세스를 제어합니다. 예를 들어 API를 OData API로 가져오는 경우 OData 요청 유효성 검사 정책을 사용합니다. SAP 보안 주체 전파 및 X-CSRF 토큰 가져오기에 대한 정책 코드 조각도 참조하세요.
• API를 규모에 맞게 배포, 관리 및 마이그레이션하기 위한 지침은 다음을 참조합니다.
  • APIOps를 사용한 자동화된 API 배포
  • Azure Resource Manager 템플릿을 사용하여 API Management에 대한 CI/CD

관련 항목

• API 가져오기 제한 사항
• OpenAPI 사양 가져오기
• SOAP API 가져오기
• SOAP API를 가져와서 REST로 변환
• App Service API 가져오기
• 컨테이너 앱 API 가져오기
• WebSocket API 가져오기
• GraphQL API 가져오기
• GraphQL 스키마 가져오기 및 필드 확인자 설정
• Azure 함수 앱 가져오기
• Azure 논리 앱 가져오기
• Service Fabric 서비스 가져오기
• Azure OpenAI API 가져오기
• OData API 가져오기
• SAP OData 메타데이터 가져오기
• gRPC API 가져오기
• API 편집