OpenAPI Python Generatore

Lo strumento OpenAPI Python Generator crea il codice del server Python FastAPI in base alle specifiche OpenAPI 3.0. Questo codice aiuta a creare rapidamente gli endpoint API definiti nel documento OpenAPI, in modo da potersi concentrare sull'implementazione della logica di business, invece di scrivere codice boilerplate.

Importante: assicurati di aver creato in precedenza un documento " OpenAPI ".
Punti salienti
  • Genera un server backend Python FastAPI basato su una specifica OpenAPI 3.0 di input.
  • Supporta la generazione di tre diversi tipi di server:
    • Un semplice server per la derisione delle risposte dell'API.
    • Il database crea, recupera, aggiorna ed elimina il server per le interazioni dirette con il database.
    • Connector Pack Server per interagire con le applicazioni di IBM Connectivity Pack.
Lo strumento OpenAPI Python Generator supporta le seguenti operazioni:
Tabella 1. Parametri
Parametro Obbligatorio Descrizione Predefinito
input_file Vero La specifica OpenAPI in formato YAML o JSON. Nessuna
server_type N Il tipo di server che si desidera generare. Vuoto (indica un tipo di server semplice)
database_type N Il tipo di linguaggio del database che si vuole utilizzare quando si genera il server CRUD del database Postgres

Server semplice

Un server minimalista che fornisce la configurazione di base per iniziare a costruire il vostro servizio.

Esempio di richiesta
Generate some Python FastAPI server code based on the following openapi @<filename.yaml>

Server CRUD del database

Un'estensione del Simple Server che incorpora la logica del database per eseguire operazioni di creazione, lettura, aggiornamento e cancellazione (CRUD), direttamente sul proprio database. Questo tipo è adatto alle applicazioni che richiedono una gestione persistente dei dati. Si può anche specificare la lingua del database da utilizzare per impostazione predefinita, Postgres, ma si possono utilizzare anche DynamoDB e Db2.

Esempi di prompt
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>

Server Connector Pack

La versione server del Connector Pack è progettata per generare codice finalizzato all'integrazione con il Connectivity Pack di IBM. Iniziate utilizzando OASCreator Tool per creare una specifica OpenAPI 3.0 su misura per questo tipo di server. Questa generazione di codice consente di fornire informazioni importanti, necessarie per la generazione dell'applicazione del connettore. A partire da questa specifica, il generatore produce sia un backend FastAPI che una libreria Client SDK che gestisce tutte le comunicazioni con l'endpoint IBM Connectivity Pack.

Sono supportate le seguenti applicazioni di IBM Connectivity Pack:
  • Postgres
  • DynamoDB
  • Db2
  • Salesforce
  • ServiceNow
Esempi di prompt
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>
Importante:
  1. Per le applicazioni supportate da API Agent è necessario portare le proprie credenziali per effettuare chiamate API al percorso IBM Connectivity Pack fornito. Queste credenziali devono essere inserite nel sito config.json. La configurazione delle credenziali varia a seconda delle applicazioni.