Génération d'une représentation OpenAPI

OpenAPI est une version normalisée de la spécification Swagger. Il permet de présenter les API REST suivant une approche indépendante de la langue. Vous pouvez générer des représentations OpenAPI pour l'exécution de services de décision. Cette possibilité fait partie des capacités d'ODM Decision Connect, qui permet d'exposer des décisions réutilisables sous la forme d'API publiques basées sur OpenAPI qui pourront être appelées directement par des applications. Les décisions OpenAPI-based peuvent également être publiées dans un catalogue IBM API Connect® pour les API gérées. IBM API Connect Essentials est aussi une partie facultative de Decision Connect.

A propos de cette tâche

Pour écrire une entrée JSON pour la méthode POST dans un URI de point d'extrémité d'ensemble de règles spécifique, vous pouvez générer la représentation OpenAPI. La représentation OpenAPI contient une entrée pour la méthode POST.

Pour générer une représentation OpenAPI, vous pouvez utiliser les URI d'extrémité. Pour plus d'informations sur OpenAPI,, voir la page The OpenAPI Specification Le lien externe ouvre une nouvelle fenêtre ou un nouvel onglet

du site web de l'Open API Initiative.

Note : Les API REST utilisent OpenAPI 3.0. Pour plus d'informations, voir OpenAPI Specification Le lien externe ouvre une nouvelle fenêtre ou un nouvel onglet

Procédure

Définissez la demande :
```
https://<vhostname>.bpm.ibmcloud.com/odm/<odm_on_cloud_environment>/DecisionService/rest/v1/{rulesetPath}/openapi?format={format}
```
Définissez {format} sur le format du fichier de définition OpenAPI, à savoir YAML ou JSON. Le format par défaut est YAML.

Les variables URI sont définies dans Endpoint URIs.
L'exemple suivant illustre une demande de génération d'une représentation OpenAPI au format YAML :
```
GET https://vhost005.bpm.ibmcloud.com/odm/dev/DecisionService/rest/v1/miniloanruleapp/1.0/miniloanrules/1.0/openapi?format=YAML
```
Facultatif : Pour utiliser le fichier OpenAPI dans IBM API Connect, utilisez le paramètre de requête extension et spécifiez apiconnect.
L'exemple suivant illustre une demande de génération d'une représentation OpenAPI au format YAML et de son utilisation dans 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
```

Résultats

Vous avez généré une représentation OpenAPI au format YAML ou JSON.

Si vous avez utilisé une URL non valide ou si une erreur se produit pendant la génération de la représentation OpenAPI, un code d'état d'erreur est renvoyé.

Si vous avez envoyé la demande à partir d'un navigateur, une page HTML affiche le message d'erreur.
Remarque: le code de statut est200malgré le message d'erreur car il s'applique à la page HTML et non au résultat de la demande.
Si vous avez envoyé la demande à partir d'un client autre qu'un navigateur, un code de statut404 (Not Found)est renvoyé et l'erreur est décrite dans XML.

Vous trouverez une description des messages d'erreur dans les codes d'état HTTP.