Gerando uma Representação OpenAPI

OpenAPI é uma versão padronizada da especificação Swagger. Ela fornece uma forma independente de linguagem para representar APIs REST. É possível gerar representações do OpenAPI para executar serviços de decisão. Esse recurso faz parte do ODM Decision Connect, que permite que as decisões reutilizáveis sejam expostas como APIs públicas baseadas em OpenAPI para serem chamadas diretamente por aplicativos As decisões do OpenAPI-based também podem ser publicadas em um catálogo IBM API Connect® para APIs gerenciadas. O IBM API Connect Essentials também é uma parte opcional do Decision Connect.

Sobre esta Tarefa

Para gravar uma entrada JSON para o método POST para um URI de terminal do conjunto de regras específico, é possível gerar a representação OpenAPI. A representação OpenAPI contém uma entrada para o método POST.

Para gerar uma representação em OpenAPI, você pode usar os URIs de ponto de extremidade. Para obter mais informações sobre OpenAPI,, consulte a página The OpenAPI Specification O link externo abre uma nova janela ou guia

do site da Open API Initiative.

Observação: As APIs REST usam OpenAPI 3.0. Para obter mais informações, consulte OpenAPI Specification O link externo abre uma nova janela ou guia

Procedimento

Defina a solicitação:
```
https://<vhostname>.bpm.ibmcloud.com/odm/<odm_on_cloud_environment>/DecisionService/rest/v1/{rulesetPath}/openapi?format={format}
```
Configure {format} para o formato do arquivo de definição de OpenAPI, que é YAML ou JSON. O formato padrão é YAML.

As variáveis de URI são definidas em URIs de ponto de extremidade.
O exemplo a seguir mostra uma solicitação para gerar uma representação de OpenAPI no formato YAML:
```
GET https://vhost005.bpm.ibmcloud.com/odm/dev/DecisionService/rest/v1/miniloanruleapp/1.0/miniloanrules/1.0/openapi?format=YAML
```
Opcional: Para usar o arquivo OpenAPI em IBM API Connect, use o parâmetro de consulta extension e especifique apiconnect.
O exemplo a seguir mostra uma solicitação para gerar uma representação OpenAPI no formato YAML e usá-la no IBM API Connect:
```
GET https://vhost005.bpm.ibmcloud.com/odm/dev/DecisionService/rest/v1/miniloanruleapp/1.0/miniloanrules/1.0/openapi?format=YAML&extension=apiconnect
```

Resultados

Uma representação OpenAPI foi gerada no formato YAML ou JSON.

Se você usar uma URL inválida ou se um erro ocorrer durante a geração de OpenAPI, um código de status de erro é retornado.

Se você enviou a solicitação a partir de um navegador, uma página HTML exibirá a mensagem de erro.
Nota: O código de status é200apesar da mensagem de erro porque se aplica à página HTML, não ao resultado da solicitação.
Se você enviou a solicitação de um cliente diferente de um navegador, um código de status404 (Not Found)é retornado e o erro é descrito em XML.

Você pode encontrar uma descrição das mensagens de erro nos códigos de status HTTP.