Generazione di una rappresentazione OpenAPI

OpenAPI è una versione standardizzata della specifica Swagger. Fornisce un modo indipendente dalla lingua per presentare le API REST. È possibile generare rappresentazioni OpenAPI per l'esecuzione dei servizi di decisione. Questa funzionalità fa parte di ODM Decision Connect, che consente alle decisioni riutilizzabili di essere esposte come API pubbliche basate su OpenAPI da richiamare direttamente dalle applicazioni. Le decisioni OpenAPI-based possono anche essere pubblicate in un catalogo IBM API Connect® per le API gestite. IBM API Connect Essentials è anche una parte facoltativa di Decision Connect.

Informazioni su questa attività

Per scrivere l'input JSON per il metodo POST in uno specifico URI dell'endpoint della serie di regole, puoi creare la rappresentazione OpenAPI . La rappresentazione OpenAPI contiene una voce per il metodo POST.

Per generare una rappresentazione OpenAPI, è possibile utilizzare gli URI Endpoint. Per ulteriori informazioni su OpenAPI,, consultare la pagina delle specifiche di OpenAPI Il link esterno apre una nuova finestra o scheda del sito web dell'Open API Initiative.
Nota: Le API REST utilizzano OpenAPI 3.0. Per ulteriori informazioni, consultare la specifica OpenAPI Il link esterno apre una nuova finestra o scheda.

Procedura

  1. Definire la richiesta:
    https://<vhostname>.bpm.ibmcloud.com/odm/<odm_on_cloud_environment>/DecisionService/rest/v1/{rulesetPath}/openapi?format={format}

    Imposta {format} sul formato del file di definizione OpenAPI , che è YAML o JSON. Il formato predefinito è YAML.

    Le variabili URI sono definite in URI endpoint.

    Il seguente esempio mostra una richiesta di generare una rappresentazione OpenAPI in formato YAML:

    GET https://vhost005.bpm.ibmcloud.com/odm/dev/DecisionService/rest/v1/miniloanruleapp/1.0/miniloanrules/1.0/openapi?format=YAML
  2. Opzionale: Per utilizzare il file OpenAPI in IBM API Connect, utilizzare il parametro di query extension e specificare apiconnect.
    Il seguente esempio mostra una richiesta per generare una rappresentazione OpenAPI in formato YAML e utilizzarla in 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

Risultati

Hai generato una rappresentazione OpenAPI in formato YAML o JSON.

Se si utilizza un URL non valido o se si verifica un errore durante la generazione di OpenAPI, viene restituito un codice di stato di errore.
  • Se la richiesta è stata inviata da un browser, una pagina HTML visualizza il messaggio di errore.
    Nota: il codice di stato è200nonostante il messaggio di errore perché si applica alla pagina HTML, non al risultato della richiesta.
  • Se la richiesta è stata inviata da un client diverso da un browser, un codice di stato404 (Not Found)viene restituito e l'errore viene descritto in XML.
La descrizione dei messaggi di errore è contenuta nei codici di stato HTTP.