OpenAPI 표시 생성

OpenAPI는 Swagger 스펙의 표준화된 버전입니다. 이는 언어 독립적인 REST API 표시 방법을 제공합니다. 의사결정 서비스를 실행하기 위한 OpenAPI 표시를 생성할 수 있습니다. 이 기능은 ODM Decision Connect의 일부이며, 이를 통해 재사용 가능한 의사결정은 애플리케이션이 직접 호출하는 OpenAPI 기반 공용 API로서 노출될 수 있습니다. OpenAPI 기반 의사결정은 관리 API에 대한 IBM API Connect 카탈로그에도 공개될 수 있습니다. IBM API Connect Essentials도 Decision Connect의 선택적 파트입니다.

시작하기 전에

클라이언트에서 REST 서비스를 사용할 수 있으려면 먼저 샘플 서버를 시작하거나 애플리케이션 서버에 대해 Rule Execution Server를 구성해야 합니다. 샘플 서버 시작 및 중지 또는 구성을 참조하십시오.

이 태스크 정보

POST 메소드에 대한 JSON 입력을 특정 규칙 세트 엔드포인트 URI에 쓰기 위해 OpenAPI 표시를 생성할 수 있습니다. OpenAPI 표시는 POST 메소드에 대해 하나의 항목을 포함합니다.

OpenAPI 표시를 생성하기 위해 엔드포인트 URI를 사용할 수 있습니다. OpenAPI에 대한 자세한 정보는 Open API Initiative 웹 사이트의 OpenAPI 스펙 페이지를 참조하십시오.

참고: OpenAPI 스펙의 버전 2.0이 지원됩니다.

프로시저

다음과 같이 요청을 정의하십시오.
```
http://{host}:{port}/DecisionService/rest/v1/{rulesetPath}/openapi?format={format}
```
{format}을 OpenAPI 정의 파일의 형식(YAML 또는 JSON)으로 지정합니다. 기본 형식은 YAML입니다.

URI 변수가 엔드포인트 URI에 정의되어 있습니다.

다음 예제는 OpenAPI 표시를 YAML 형식으로 생성하는 요청을 보여줍니다.
```
GET http://localhost:9080/DecisionService/rest/v1/miniloanruleapp/1.0/miniloanrules/1.0/openapi?format=YAML
```
옵션: IBM API Connect™에서 OpenAPI 파일을 사용하려면 extension 조회 매개변수를 사용하고 apiconnect를 지정하십시오.
다음 예제는 OpenAPI 표시를 YAML 형식으로 생성하고 IBM API Connect에서 사용하는 요청을 보여줍니다.
```
GET http://localhost:9080/DecisionService/rest/v1/miniloanruleapp/1.0/miniloanrules/1.0/openapi?format=YAML&extension=apiconnect
```

결과

OpenAPI 표시를 YAML 또는 JSON 형식으로 생성했습니다.

올바르지 않은 URL을 사용했거나 OpenAPI 생성 중 오류가 발생한 경우 오류 상태 코드가 리턴됩니다.

브라우저에서 요청을 전송하면 HTML 페이지는 오류 메시지를 표시합니다.
참고: 상태 코드는 요청 결과가 아니라 HTML 페이지에 적용되므로 오류 메시지가 출력되는 경우에도 이 코드는 200입니다.
브라우저가 아닌 클라이언트에서 요청을 보낸 경우, 상태 코드 404(찾을 수 없음)가 리턴되고 XML로 오류가 기술됩니다.

HTTP 상태 코드에서 오류 메시지에 대한 설명을 찾을 수 있습니다.