OpenAPI Générateur

L'outil de génération OpenAPI génère des documents OpenAPI à partir de zéro, sur la base des invites que vous fournissez.

L'outil de génération OpenAPI peut être utilisé pour générer des documents OpenAPI 3.0 au format JSON ou YAML à partir de zéro sur la base d'invites fournies par l'utilisateur qui utilise le traitement du langage naturel (NLP). À partir d'une description en langage naturel d'une API ou d'une application pour laquelle l'utilisateur souhaite générer un document OpenAPI, l'outil utilise le modèle Granite 3 disponible sur IBM watsonx pour générer une première version d'un document OpenAPI que l'utilisateur peut ensuite reprendre et développer.
Remarque : l'outil génère un document OpenAPI à partir d'une description en langage naturel, tandis que l'outil OAS creator génère les documents OpenAPI à partir d'un schéma de base de données existant qui a été ajouté aux sources de l'agent API.

Détails et limites de l'outil

Voici les détails et les limites de l'outil Open API Generator :
  • Cet outil est fourni pour aider les utilisateurs à générer un document OpenAPI à partir d'une description en langage naturel. Il ne doit pas être confondu avec l'outil OAS creator, également disponible sur le site API Agent, qui est utilisé pour générer un document OpenAPI à partir d'un schéma de base de données existant ajouté aux sources de l'agent API.
  • Cet outil s'appuie sur le modèle de base Granite 3 disponible à l'adresse IBM watsonx pour la génération de documents OpenAPI.
  • Étant donné que cet outil s'appuie sur la sortie du modèle de fondation basé sur la description d'entrée fournie, comme tous les modèles d'IA, la sortie est sujette à des erreurs.
  • Si le document OpenAPI généré ne correspond pas à la description fournie en entrée, réessayez et envisagez de reformuler la description.
  • Si le document OpenAPI généré et affiché à partir du modèle contient des erreurs, telles que des erreurs de spécification OpenAPI ou des erreurs sémantiques, l'outil passe automatiquement le document par l'opération de correction (autocorrection) de l'outil OpenAPI Enhancer. Si des erreurs subsistent après cette correction, elles seront signalées dans la fenêtre de discussion.

  • Si le document OpenAPI généré contient des erreurs de syntaxe JSON ou YAML qui ne peuvent pas être corrigées (auto-correction) par l'outil OpenAPI Enhancer, l'outil n'affiche pas le document. Dans cette situation, le système affiche le message suivant : please re-phrase and try again. Essayez de reformuler la description de l'entrée avant de réessayer, par exemple en utilisant un ordre ou une combinaison de mots différents dans l'invite d'entrée.

  • Tous les documents OpenAPI générés par cet outil doivent être vérifiés pour s'assurer qu'ils sont corrects et exacts avant d'être utilisés.

Générer un document OpenAPI à partir d'une description en langage naturel

Vous pouvez générer un document OpenAPI 3.0 à partir de zéro au format JSON ou YAML, à partir d'une description en langage naturel donnée en anglais (une ou plusieurs phrases) pour l'API ou l'application que vous souhaitez générer. Commencez simplement votre message par Generate an openapi for.... Le document OpenAPI généré contient des schémas de composants pertinents pour l'API ou l'application décrite, ainsi que des éléments de chemin d'accès pour les opérations de création, d'extraction, de mise à jour et de suppression de ces schémas. En outre, le document généré inclut par défaut les schémas de sécurité et de niveau opérationnel recommandés, à moins qu'il ne soit explicitement demandé de ne pas le faire.

Note : Décomposez le message en plusieurs phrases significatives. Vous pouvez mentionner le type d'API que vous souhaitez générer dans la première phrase et les spécifications requises dans les phrases suivantes.

Cette opération présente les détails suivants : Le document OpenAPI 3.0 généré au format JSON ou YAML (par défaut, si le format YAML n'est pas spécifié dans le message d'invite) qui peut être téléchargé.

Tableau 1. Paramètres
Paramètre Obligatoire Descriptif Par défaut
text Oui Description en langage naturel de la spécification OpenAPI 3.0 à générer
Remarque :

L'intégralité du message d'invite à la saisie est utilisée comme valeur du paramètre texte. Il n'est pas nécessaire d'y faire référence explicitement.

 Aucun
file_format Non L'outil Open API Generator prend en charge le format de sortie du fichier de document OpenAPI généré en JSON et YAML. YAML
Exemples d'invites
Generate an OpenAPI spec for a weather application

Generate an OpenAPI spec for a book library application

Generate an openapi for a blog application in yaml format

Generate an OpenAPI spec for a blog application. Include operations for searching for blogs by most recommended topics. Searching for blogs should not require any authentication

Generate an OpenAPI spec for a weather application. Include an operation to provide a 7-day forecast for a given location

Genrate an OpenAPI spec for a book library application. Include operations to add and remove books from the library. Also include an operation to search the books in the library with a title

Prochaine action proposée

  • Générer le code serveur fastapi pour le fichier openapi {@filename}
  • Générer le code du serveur fastapi avec l'intégration de la base de données pour le fichier openapi {@filename}