API Agent ajuda você a gerar código Python a partir de uma especificação OpenAPI, implantar o código gerado em IBM Code Engine e atualizar o documento de origem OpenAPI para refletir o aplicativo Code Engine URL após a implantação.
Sobre esta tarefa
Use API Agent para gerar o código do servidor Python FastAPI com base em sua especificação OpenAPI 3.0. Para obter mais detalhes sobre como gerar o código do servidor Python FastAPI, consulte OpenAPI Python Generator tool.
As etapas a seguir fornecem um exemplo de fluxo de cenário único de como criar código de servidor para um servidor CRUD de banco de dados.
Procedimento
Para gerar um código Python, conclua as etapas a seguir:
- Faça login em API Agent. Para obter detalhes, consulte Introdução.
- Digite o prompt a seguir e clique em Send (Enviar ):
Generate some Python FastAPI server with database interaction code based on the following openapi @
e selecione o arquivo necessário, por exemplo,
order_apispec.yaml.
Observação: digitar @ após o prompt exibe uma lista de documentos OpenAPI disponíveis em seu espaço de trabalho.
- Clique em Send (Enviar ). A ferramenta OpenAPI Python Generator se comunica com as fontes do API Agent e exibe o plano proposto.
- Clique em Start (Iniciar ) para iniciar a geração de código. Depois de concluído, você poderá ver um breve resumo das próximas etapas necessárias para fazer o download do código gerado, bem como a forma de executá-lo e implantá-lo.
- Clique no ícone de download para salvar o arquivo ZIP que contém o código.
- Em Visual Studio Code, abra o Terminal e execute o seguinte comando para extrair o arquivo baixado em uma pasta, por exemplo,
app-code.
unzip PostgreSQL-order-python.zip
- Abra o arquivo
README.md para ver as instruções sobre como começar a usar o código baixado. O site README.md fornece informações detalhadas sobre como criar, instalar, personalizar e implementar o aplicativo.
- Digite o prompt a seguir para implantar o zip da pasta gerada (certifique-se de que suas credenciais estejam preenchidas):
zip -r code.zip app_code/
Observação: O tamanho do arquivo deve ser menor que 1MB. Remova a pasta venv/ antes de compactar seu código e implementá-lo.
- A próxima ação sugerida:
Deploy the application code from code.zip
Observação: Se a próxima ação planejada for implantar o aplicativo de servidor Python FastAPI gerado em IBM Code Engine usando a ferramenta
de implantação de código, certifique-se de que o documento de origem OpenAPI a partir do qual o aplicativo foi gerado seja atualizado após a implantação para refletir o aplicativo Code Engine URL como o valor de
servers[0].url. Essa etapa é crucial se a ação planejada subsequente for criar um rascunho de API e publicá-lo em API Connect usando a ferramenta
API Connect Task. Para obter mais informações, consulte a seção
Status da implantação do código.