API Agent le ayuda a generar código Python a partir de una especificación OpenAPI, desplegar el código generado en IBM Code Engine, y actualizar el documento fuente OpenAPI para reflejar la aplicación Code Engine URL tras el despliegue.
Acerca de esta tarea
Utilice API Agent para generar Python FastAPI código de servidor basado en su OpenAPI Especificación 3.0. Para obtener más información sobre cómo generar el código del servidor Python FastAPI, consulte la herramienta OpenAPI Python Generator.
Los siguientes pasos le dan un ejemplo de flujo de escenario único de cómo crear código de servidor para un servidor CRUD de base de datos.
Procedimiento
Para generar un código Python, siga estos pasos:
- Inicie sesión en API Agent. Para más detalles, consulte Introducción.
- Introduzca el siguiente mensaje y haga clic en Enviar :
Generate some Python FastAPI server with database interaction code based on the following openapi @
y seleccione el archivo deseado, por ejemplo,
order_apispec.yaml.
Nota: Si introduce @ después de la pregunta, aparecerá una lista de los documentos de OpenAPI disponibles en su área de trabajo.
- Haga clic en Enviar. La herramienta OpenAPI Python Generator se comunica con las fuentes del Agente API y muestra el plan propuesto.
- Haga clic en Iniciar para comenzar la generación del código. Una vez completado, puede ver un breve resumen de los siguientes pasos necesarios para descargar el código generado, así como la forma de ejecutarlo y desplegarlo.
- Haga clic en el icono de descarga para guardar el archivo ZIP que contiene el código.
- En Visual Studio Code, abra el Terminal y ejecute el siguiente comando para extraer el archivo descargado en una carpeta, por ejemplo,
app-code.
unzip PostgreSQL-order-python.zip
- Abra el archivo
README.md para ver las instrucciones sobre cómo empezar a utilizar el código descargado. En README.md encontrará información detallada sobre cómo crear, instalar, personalizar y desplegar la aplicación. - Introduzca la siguiente solicitud para desplegar la carpeta generada (asegúrese de que sus credenciales están rellenadas):
zip -r code.zip app_code/
Nota: El tamaño del archivo debe ser inferior a 1MB. Elimine la carpeta venv/ antes de comprimir el código y desplegarlo.
- La siguiente acción sugerida:
Deploy the application code from code.zip
Nota: Si la siguiente acción prevista es implementar la aplicación de servidor generada Python FastAPI en IBM Code Engine mediante la herramienta
de implementación de código, asegúrese de que el documento de origen OpenAPI a partir del cual se generó la aplicación se actualice tras la implementación para reflejar la aplicación Code Engine URL como valor de
servers[0].url. Este paso es fundamental si la acción prevista a continuación es crear un borrador de API y publicarlo en API Connect utilizando la
herramienta « API Connect ». Para más información, consulte la sección
Estado de despliegue del código.