OpenAPI Python Gerador

A ferramenta OpenAPI Python Generator cria o código do servidor Python FastAPI com base em sua especificação OpenAPI 3.0. Esse código o ajuda a estruturar rapidamente os pontos de extremidade da API definidos no documento OpenAPI para que você possa se concentrar na implementação da lógica comercial em vez de escrever código padrão.

Importante: Certifique-se de ter criado o documento OpenAPI com antecedência.
Principais destaques
  • Gera um servidor backend Python FastAPI com base em uma especificação de entrada OpenAPI 3.0.
  • Suporta a geração de três tipos diferentes de servidores:
    • Servidor simples para simular respostas de API.
    • O banco de dados cria, recupera, atualiza e exclui o servidor para interações diretas com o banco de dados.
    • Connector Pack Server para interagir com os aplicativos do IBM Connectivity Pack.
As seguintes operações são compatíveis com a ferramenta OpenAPI Python Generator:
Tabela 1. Parâmetros
Parâmetro Necessário Descrição Padrão
input_file True A especificação OpenAPI no formato YAML ou JSON. Nenhum
server_type Não O tipo de servidor que você deseja gerar. Em branco (indicando um tipo de servidor simples)
database_type Não O tipo de linguagem do banco de dados que você deseja usar ao gerar o servidor do tipo CRUD do banco de dados Postgres

Servidor simples

Um servidor minimalista que fornece a configuração básica para começar a criar seu serviço.

Exemplo de solicitação
Generate some Python FastAPI server code based on the following openapi @<filename.yaml>

Servidor CRUD de banco de dados

Uma extensão do Simple Server que incorpora a lógica do banco de dados para executar operações de criação, leitura, atualização e exclusão (CRUD), diretamente no seu próprio banco de dados. Esse tipo é adequado para aplicativos que exigem gerenciamento de dados persistentes. Você também pode especificar um idioma de banco de dados a ser usado. Por padrão, Postgres é usado, mas você também pode usar DynamoDB e Db2.

Exemplos de prompts
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

A variante de servidor do Connector Pack foi projetada para gerar código para integração com o Connectivity Pack do site IBM. Comece usando OASCreator Tool para criar uma especificação OpenAPI 3.0 personalizada para esse tipo de servidor. Essa geração de código permite fornecer informações importantes que são necessárias para a geração do aplicativo conector. A partir dessa especificação, o gerador produz um backend FastAPI e uma biblioteca Client SDK que trata de toda a comunicação com o endpoint IBM Connectivity Pack.

Os seguintes aplicativos do IBM Connectivity Pack são compatíveis:
  • Postgres
  • DynamoDB
  • Db2
  • Salesforce
  • ServiceNow
Exemplos de prompts
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. O conector do pacote de conectividade IBM URL é preenchido automaticamente em seu site gerado config.json. Essa rota tem APIs na lista de permissões que só permitem que os aplicativos que foram implementados na instância IBM gerenciada Code Engine a chamem. Você não poderá fazer chamadas de API locais para essa rota.
  2. Para os aplicativos compatíveis com o API Agent , você deve trazer suas próprias credenciais para fazer chamadas de API para a rota fornecida pelo IBM Connectivity Pack. Essas credenciais devem ser inseridas no site gerado config.json. A configuração das credenciais varia de acordo com os aplicativos.