Generación de una representación OpenAPI

OpenAPI es una versión estandarizada de la especificación Swagger. Proporciona un modo independiente del idioma de presentar API REST. Puede generar representaciones OpenAPI para ejecutar servicio de decisiones. Esta función forma parte de ODM Decision Connect, que permite que las decisiones reutilizables se expongan como API públicas basadas en OpenAPI para que las invoquen directamente las aplicaciones. Las decisiones de OpenAPI-based también pueden publicarse en un catálogo de IBM API Connect® para API gestionadas. IBM API Connect Essentials también es una parte esencial de Decision Connect.

Acerca de esta tarea

Para grabar la entrada JSON apara el método en un URI de puntos finales de conjunto de reglas específico, puede generar la representación OpenAPI. La representación OpenAPI contiene una entrada para el método POST.

Para generar una representación OpenAPI, puede utilizar las URI de los extremos. Para más información sobre OpenAPI,, consulte la página OpenAPI Specification El enlace externo abre una nueva ventana o pestaña

del sitio web de la Iniciativa API Abierta.

Nota: Las API REST utilizan OpenAPI 3.0. Para más información, consulte OpenAPI Especificaciones El enlace externo abre una nueva ventana o pestaña

Procedimiento

Defina la solicitud:
```
https://<vhostname>.bpm.ibmcloud.com/odm/<odm_on_cloud_environment>/DecisionService/rest/v1/{rulesetPath}/openapi?format={format}
```
Establezca {formato} en el formato del archivo de definición OpenAPI, que es YAML o JSON. El formato predeterminado es YAML.

Las variables URI se definen en Endpoint URIs.
El siguiente ejemplo muestra una solicitud para generar una representación OpenAPI en formato YAML:
```
GET https://vhost005.bpm.ibmcloud.com/odm/dev/DecisionService/rest/v1/miniloanruleapp/1.0/miniloanrules/1.0/openapi?format=YAML
```
Opcional: Para utilizar el archivo OpenAPI en IBM API Connect, utilice el parámetro de consulta extension y especifique apiconnect.
El ejemplo siguiente muestra una solicitud para generar una representación OpenAPI en formato YAML y utilizarla en 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

Ha generado una representación de OpenAPI en formato YAML o JSON.

Si ha utilizado un URL no válido o si se produce un error durante la generación de OpenAPI, se devuelve un código de estado de error.

Si ha enviado la petición desde un navegador, una página HTML muestra el mensaje de error.
Nota: El código de estado es200a pesar del mensaje de error porque se aplica a la página HTML, no al resultado de la solicitud.
Si ha enviado la solicitud desde un cliente que no sea un navegador, un código de estado404 (Not Found)y el error se describe en XML.

Puede encontrar una descripción de los mensajes de error en los códigos de estado HTTP.