OpenAPI Python Stromerzeuger

Das Tool OpenAPI Python Generator erstellt Python FastAPI Servercode auf der Grundlage Ihrer OpenAPI Spezifikation 3.0 Spezifikation. Dieser Code hilft Ihnen dabei, API-Endpunkte, die in Ihrem OpenAPI Dokument definiert sind, schnell einzurichten, so dass Sie sich auf die Implementierung der Geschäftslogik konzentrieren können, anstatt Kesselsteincode zu schreiben.

Wichtig: Vergewissern Sie sich, dass Sie zuvor das Dokument OpenAPI erstellt haben.
Wichtigste Highlights
  • Erzeugt einen Python FastAPI Backend-Server auf der Grundlage einer OpenAPI 3.0 Spezifikation.
  • Unterstützt die Erstellung von drei verschiedenen Servertypen:
    • Einfacher Server für Mocking-API-Antworten.
    • Datenbank erstellt, abruft, aktualisiert und löscht Server für direkte Datenbankinteraktionen.
    • Connector Pack Server für die Interaktion mit den Anwendungen des IBM Connectivity Pack.
Die folgenden Operationen werden vom OpenAPI Python Generator unterstützt:
Tabelle 1. Parameter
Parameter Erforderlich Beschreibung Standard
input_file Ja Die OpenAPI Spezifikation im YAML- oder JSON-Format. Keine
server_type Nein Der Servertyp, den Sie generieren möchten. Leer (gibt einen einfachen Servertyp an)
database_type Nein Der Datenbanksprachen-Typ, den Sie bei der Generierung des Datenbank-CRUD-Typs Server verwenden möchten Postgres

Einfacher Server

Ein minimalistischer Server, der die Grundausstattung für den Aufbau Ihres Dienstes bietet.

Beispiel für eine Aufforderung
Generate some Python FastAPI server code based on the following openapi @<filename.yaml>

Datenbank-CRUD-Server

Eine Erweiterung des Simple Servers, die Datenbanklogik enthält, um CRUD-Operationen (Erstellen, Lesen, Aktualisieren und Löschen) direkt in Ihrer eigenen Datenbank durchzuführen. Dieser Typ ist für Anwendungen geeignet, die eine dauerhafte Datenverwaltung erfordern. Sie können auch eine Datenbanksprache angeben, die standardmäßig Postgres verwendet wird, aber Sie können auch DynamoDB und Db2 verwenden.

Beispielhafte Aufforderungen
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>

Connector Pack Server

Die Server-Variante des Connector Packs wurde entwickelt, um Code für die Integration mit dem IBM Connectivity Pack zu generieren. Verwenden Sie zunächst OASCreator Tool , um eine maßgeschneiderte OpenAPI 3.0 Spezifikation für diesen Servertyp zu erstellen. Diese Codegenerierung ermöglicht es, wichtige Informationen bereitzustellen, die für die Generierung von Konnektoranwendungen erforderlich sind. Aus dieser Spezifikation erzeugt der Generator sowohl ein FastAPI Backend als auch eine Client SDK-Bibliothek, die die gesamte Kommunikation mit dem IBM Connectivity Pack Endpunkt abwickelt.

Die folgenden IBM Connectivity Pack-Anwendungen werden unterstützt:
  • Postgres
  • DynamoDB
  • Db2
  • Salesforce
  • ServiceNow
Beispielhafte Aufforderungen
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>
Wichtig:
  1. Der IBM Connectivity Pack Connector URL wird automatisch in Ihr generiertes config.json eingefügt. Diese Route verfügt über Whitelist-APIs, die nur von Anwendungen aufgerufen werden können, die auf der von IBM verwalteten Instanz Code Engine bereitgestellt wurden. Sie können keine lokalen API-Aufrufe für diese Route tätigen.
  2. Für die von API Agent unterstützten Anwendungen müssen Sie Ihre eigenen Anmeldeinformationen mitbringen, um API-Aufrufe über die bereitgestellte IBM Connectivity Pack Route zu tätigen. Diese Anmeldedaten müssen in die generierte config.json eingegeben werden. Die Einrichtung der Anmeldeinformationen ist von Anwendung zu Anwendung unterschiedlich.