OpenAPI Python Generador

Editar en línea

La herramienta OpenAPI Python Generator crea Python FastAPI código de servidor basado en su OpenAPI especificación 3.0 especificación. Este código le ayuda a organizar rápidamente los puntos finales de la API definidos en el documento OpenAPI para que pueda centrarse en implementar la lógica empresarial en lugar de escribir código repetitivo.

Importante: Asegúrate de haber creado previamente un documento de « OpenAPI ».
Aspectos más destacados
  • Genera un servidor backend Python FastAPI basado en una especificación de entrada OpenAPI 3.0.
  • Admite la generación de tres tipos de servidores diferentes:
    • Servidor simple para imitar las respuestas de la API.
    • Base de datos crea, recupera, actualiza y elimina Servidor para interacciones directas con la base de datos.
    • Connector Pack Server para interactuar con las aplicaciones de IBM Connectivity Pack.
La herramienta OpenAPI Python Generator permite realizar las siguientes operaciones:
Tabla 1. Parámetros
Parámetro Obligatorio Descripción Valor predeterminado
input_file Sí La especificación OpenAPI en formato YAML o JSON. Ninguna
server_type Nee El tipo de servidor que desea generar. En blanco (indica un tipo de servidor simple)
database_type Nee El tipo de lenguaje de base de datos que desea utilizar al generar el servidor de tipo CRUD de base de datos Postgres

Servidor simple

Un servidor minimalista que proporciona la configuración básica para empezar a crear su servicio.

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

Servidor CRUD de base de datos

Una extensión de Simple Server que incorpora lógica de base de datos para realizar operaciones de creación, lectura, actualización y eliminación (CRUD), directamente en su propia base de datos. Este tipo es adecuado para aplicaciones que requieren una gestión persistente de los datos. También puede especificar un idioma de base de datos para utilizar por defecto Postgres se utiliza para, pero también puede utilizar DynamoDB y Db2.

Ejemplos de indicaciones
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>

Servidor Connector Pack

La variante de servidor «Connector Pack» está diseñada para generar código que permita la integración con el paquete de conectividad de IBM. Empiece por utilizar OASCreator Tool para elaborar una especificación a medida OpenAPI 3.0 para este tipo de servidor. Esta generación de código permite proporcionar información importante que es necesaria para la generación de aplicaciones de conectores. A partir de esa especificación, el generador produce tanto un backend FastAPI como una biblioteca SDK de cliente que gestiona toda la comunicación con el punto final de IBM Connectivity Pack.

Se admiten las siguientes aplicaciones de IBM Connectivity Pack:
  • Postgres
  • DynamoDB
  • Db2
  • Salesforce
  • ServiceNow
Ejemplos de indicaciones
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. Para las aplicaciones soportadas por API Agent debe traer sus propias credenciales para hacer llamadas API a la ruta IBM Connectivity Pack proporcionada. Estas credenciales deben introducirse en la dirección config.json generada. La configuración de las credenciales varía según las aplicaciones.