OpenAPI Python Générateur

Modifier en ligne

L'outil OpenAPI Python Generator crée le code serveur Python FastAPI sur la base de votre spécification OpenAPI 3.0. Ce code vous permet d'échafauder rapidement des points d'extrémité d'API définis dans votre document OpenAPI afin que vous puissiez vous concentrer sur la mise en œuvre de la logique commerciale au lieu d'écrire du code passe-partout.

Important : assurez-vous d'avoir préalablement créé un document « OpenAPI ».
Faits marquants
  • Génère un serveur backend Python FastAPI sur la base d'une spécification d'entrée OpenAPI 3.0.
  • Permet de générer trois types de serveurs différents :
    • Serveur simple pour simuler les réponses de l'API.
    • La base de données crée, récupère, met à jour et supprime le serveur pour des interactions directes avec la base de données.
    • Connector Pack Server pour interagir avec les applications IBM Connectivity Pack.
Les opérations suivantes sont prises en charge par l'outil OpenAPI Python Generator :
Tableau 1. Paramètres
Paramètre Obligatoire Descriptif Par défaut
input_file Oui La spécification OpenAPI au format YAML ou JSON. Aucun
server_type Non Le type de serveur que vous souhaitez générer. Blanc (indiquant un type de serveur simple)
database_type Non Le type de langage de la base de données que vous souhaitez utiliser lors de la génération du serveur de type CRUD de la base de données Postgres

Serveur simple

Un serveur minimaliste qui fournit la configuration de base pour commencer à construire votre service.

Exemple de demande
Generate some Python FastAPI server code based on the following openapi @<filename.yaml>

Serveur CRUD de base de données

Une extension de Simple Server qui incorpore la logique de la base de données pour effectuer des opérations de création, de lecture, de mise à jour et de suppression (CRUD), directement sur votre propre base de données. Ce type est adapté aux applications qui nécessitent une gestion persistante des données. Vous pouvez également spécifier un langage de base de données à utiliser. Par défaut, Postgres est utilisé, mais vous pouvez également utiliser DynamoDB et Db2.

Exemples d'invites
Generate some Python FastAPI server with database interaction code based on the following openapi @<filename.yaml>

Generate some Python FastAPI server with postgres database interaction code based on the following openapi @<filename.yaml>

Generate some Python FastAPI server with dynamodb database interaction code based on the following openapi @<filename.yaml>

Generate some Python FastAPI server with db2 database interaction code based on the following openapi @<filename.yaml>

Serveur Connector Pack

La version serveur du Connector Pack est conçue pour générer du code permettant l'intégration avec le Connectivity Pack d' IBM. Commencez par utiliser OASCreator Tool pour élaborer une spécification OpenAPI 3.0 adaptée à ce type de serveur. Cette génération de code permet de fournir des informations importantes qui sont nécessaires pour la génération de l'application du connecteur. À partir de cette spécification, le générateur produit à la fois un backend FastAPI et une bibliothèque Client SDK qui gère toutes les communications avec le point de terminaison IBM Connectivity Pack.

Les applications suivantes de IBM Connectivity Pack sont prises en charge :
  • Postgres
  • DynamoDB
  • Db2
  • Salesforce
  • ServiceNow
Exemples d'invites
Generate some Python FastAPI server for a connector based on the following openapi @<filename.yaml>

Generate some Python FastAPI server for a postgres connector based on the following openapi @<filename.yaml>

Generate some Python FastAPI server for a dynamodb connector based on the following openapi @<filename.yaml>

Generate some Python FastAPI server for a db2 connector based on the following openapi @<filename.yaml>

Generate some Python FastAPI server for a salesforce connector based on the following openapi @<filename.yaml>

Generate some Python FastAPI server for a servicenow connector based on the following openapi @<filename.yaml>
Important :
  1. Pour les applications prises en charge par le site API Agent , vous devez apporter vos propres informations d'identification pour effectuer des appels API à la route fournie par le IBM Connectivity Pack. Ces informations d'identification doivent être saisies dans le site config.json. La configuration des informations d'identification varie d'une application à l'autre.