API 정의 작성
IBM® 에서 API 디자이너나 명령줄 인터페이스를 API ConnectAI Gateway사용하여 API 정의를 생성할 수 있습니다.
시작하기 전에
API는 비즈니스 및 기술 기능을 제공하는 함수 세트이며 정의된 프로토콜을 사용하여 애플리케이션에서 호출할 수 있습니다. 애플리케이션은 일반적으로 모바일 또는 웹 애플리케이션이며 HTTP 프로토콜을 사용합니다. API 정의는 경로로 구성되어 있으며 다음 유형 중 하나입니다.
- REST API 정의
REST API는 일반적으로 교환되는 데이터 형식으로 JSON 또는 XML을 사용하여 HTTP 프로토콜을 사용하는 정의된 상호작용 세트입니다. 예를 들어, 데이터 요청은 HTTP GET 메소드를 사용하고 데이터 레코드는 HTTP POST 메소드를 사용할 수 있습니다. 데이터 형식의 선택은 API를 호출하는 애플리케이션의 유형에 따라서 달라집니다. JSON은 ( JavaScript™ 나 HTML을 사용하여) 사용자 인터페이스를 제공하는 웹 페이지나 모바일 애플리케이션에 주로 사용되는 반면, XML은 주로 기계 간 통신 시나리오에 사용됩니다.
프록시 또는 호출 정책을 사용하여 기존 API를 공개하고 보안을 강화할 수 있습니다.
두 경우 모두 API Designer를 사용하거나 OpenAPI 정의 파일을 작성하고 API Designer 또는 명령행 인터페이스를 사용하여 공개하여 API 정의를 구성할 수 있습니다.
IBM API ConnectIBM API ConnectIBM API Connect 으로 REST API를 푸시할 수 있습니다. 자세한 내용은 온라인 문서의 IBMIntegration Bus 를 REST API를 서버로 IBMAPI Management 전송하기 참조하십시오.- SOAP API
기존 WSDL(Web Services Description Language) 파일을 기반으로 하는 SOAP API 정의를 작성할 수 있습니다. 이 기능을 활용하면 변수 간의 분석 및 매핑을 포함하여 API ConnectAPI Connect 에서 제공하는 다양한 기능을 활용할 수 있습니다. 또한 개발자 포털의 소비자 카탈로그를 사용하여 조직 내의 기존 SOAP 서비스(서비스 지향 아키텍처(SOA) 또는 엔터프라이즈 서비스 버스(ESB) 인프라의 일부인 SOAP 서비스 포함)를 API로 공개할 수 있습니다.
명령행 인터페이스 또는 API Designer를 통해 SOAP API 정의를 작성할 수 있습니다.
이 태스크에 대한 정보
REST API 또는 SOAP API에 대한 정의를 작성할 수 있습니다.
- API Designer에서 API 정의 및 해당 조작을 처음부터 작성하거나 OpenAPI 정의 파일을 가져와서 REST API 정의를 추가할 수 있습니다. 이 도구를 사용하여 기존 엔드포인트를 호출하는 프록시 API를 신속하게 작성할 수도 있습니다.
- 이미 운영 중인 SOAP 서비스를 더 많은 사용자에게 공개하고 싶다면, IBM API ConnectIBM API ConnectIBM API Connect 에 SOAP API를 추가할 수 있습니다. 개발자 포털의 소비자 카탈로그 를 사용하여 개발자들에게 SOAP 서비스를 공개할 수 있습니다. 개발자가 SOAP API를 사용하고자 하는 경우, API ConnectAPI Connect 을 통해 해당 개발자의 가입 및 서비스 이용 권한을 관리하고, 해당 API의 사용 현황을 추적할 수 있습니다.
프로시저
- 다음 마법사 중 하나를 사용하여 API 정의를 빠르게 작성하십시오.
- API 정의를 생성한 후에는 ‘ OpenAPI ( 2.0 ) API 정의 편집’ 문서의 지침에 따라 더 세부적으로 정의할 수 있습니다.
Hiding this section as we don't know whether Velox still supports this connection. JenD Feb2018