Generazione di una OpenAPI rappresentazione

OpenAPI è una versione standardizzata delle specifiche Swagger. Fornisce un modo indipendente dal linguaggio per presentare le API REST. È possibile generare OpenAPI rappresentazioni per l'esecuzione dei servizi decisionali. Questa funzionalità fa parte di ODM Decision Connect, che consente di esporre decisioni riutilizzabili come API OpenAPI pubbliche basate su per essere richiamate direttamente dalle applicazioni. Le OpenAPI-based decisioni possono anche essere pubblicate in un IBMAPI Connect® catalogo per le API gestite. API Connect EssentialsIBM è anche una parte opzionale di Decision Connect.

Informazioni su questa attività

Per scrivere un input JSON per il metodo POST su un URI endpoint di un set di regole specifico, è possibile generare la OpenAPI rappresentazione. La OpenAPI rappresentazione contiene una voce per il metodo POST.

Per generare una OpenAPI rappresentazione, è possibile utilizzare gli URI degli endpoint. Per ulteriori informazioni, OpenAPI, consultare Le OpenAPI Specifiche Il link esterno apre una nuova finestra o scheda

la pagina del sito web dell'Open API Initiative.

Nota: le API REST utilizzano OpenAPI 3.0. Per ulteriori informazioni, consultare la sezione OpenAPI Specifiche Il link esterno apre una nuova finestra o scheda

Procedura

Definisci la richiesta:
```
https://<vhostname>.bpm.ibmcloud.com/odm/<odm_on_cloud_environment>/DecisionService/rest/v1/{rulesetPath}/openapi?format={format}
```
Imposta {format} il formato del file OpenAPI di definizione, che può essere YAML o JSON. Il formato predefinito è YAML.

Le variabili URI sono definite negli URI degli endpoint.
L'esempio seguente mostra una richiesta per generare una OpenAPI rappresentazione in formato YAML:
```
GET https://vhost005.bpm.ibmcloud.com/odm/dev/DecisionService/rest/v1/miniloanruleapp/1.0/miniloanrules/1.0/openapi?format=YAML
```
Opzionale: per utilizzare il OpenAPI file in IBM API Connect, utilizzare il extension parametro di query e specificare apiconnect.
L'esempio seguente mostra una richiesta per generare una OpenAPI rappresentazione in formato YAML e utilizzarla in IBMAPI 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 OpenAPI rappresentazione in formato YAML o JSON.

Se è stato utilizzato un codice non valido URL o se si verifica un errore durante la OpenAPI generazione, viene restituito un codice di stato di errore.

Se hai inviato la richiesta da un browser, una pagina HTML visualizza il messaggio di errore.
Nota: il codice di stato è200nonostante il messaggio di errore, poiché si riferisce alla pagina HTML e non al risultato della richiesta.
Se hai inviato la richiesta da un client diverso da un browser, un codice di stato404 (Not Found)viene restituito e l'errore viene descritto in XML.

È possibile trovare una descrizione dei messaggi di errore nei HTTP codici di stato.