OpenAPI Gerador

A ferramenta geradora OpenAPI gera documentos OpenAPI do zero com base nos prompts que você fornece.

A ferramenta geradora OpenAPI pode ser usada para gerar documentos OpenAPI 3.0 no formato JSON ou YAML a partir do zero, com base em prompts fornecidos pelo usuário que usa processamento de linguagem natural (NLP). Considerando uma descrição em linguagem natural de uma API ou aplicativo como entrada para a qual o usuário gostaria de gerar um documento OpenAPI, a ferramenta usa o modelo Granite 3 disponível em IBM watsonx para gerar um esboço inicial de um documento OpenAPI que o usuário pode usar e continuar a desenvolver.

Observação: a ferramenta gera documentos OpenAPI a partir de uma descrição em linguagem natural, enquanto a ferramenta de criação de OAS gera documentos OpenAPI a partir de um esquema de banco de dados existente adicionado às fontes do agente de API.

Detalhes e limitações da ferramenta

Veja a seguir os detalhes e as limitações da ferramenta Open API Generator:

Essa ferramenta é fornecida para auxiliar os usuários na tarefa de gerar um documento OpenAPI a partir do zero com base em uma descrição de linguagem natural. Ela não deve ser confundida com a ferramenta OAS creator, também disponível para o API Agent, que é usada para gerar um documento OpenAPI a partir de um esquema de banco de dados existente adicionado às fontes do API Agent.
Essa ferramenta se baseia no modelo de fundação Granite 3 disponível IBM watsonx para a geração de documentos OpenAPI.
Como essa ferramenta depende do resultado do modelo de fundação com base na descrição de entrada fornecida, como todos os modelos de IA, o resultado está sujeito a erros.
Se o documento OpenAPI gerado não corresponder à descrição fornecida como entrada, tente novamente e considere reformular a descrição.
Se o documento OpenAPI gerado e exibido a partir do modelo contiver erros, como erros de especificação OpenAPI ou erros semânticos, a ferramenta passará automaticamente o documento pela operação de correção (autocorreção) da ferramenta OpenAPI Enhancer. Se ainda houver erros após essa correção, eles serão relatados na janela de bate-papo.
Se o documento OpenAPI gerado contiver erros de sintaxe JSON ou YAML que não possam ser corrigidos (autocorrigidos) pela ferramenta OpenAPI Enhancer, a ferramenta não exibirá o documento. Nessa situação, o sistema exibe a seguinte mensagem: please re-phrase and try again. Tente reformular a descrição da entrada antes de tentar novamente, por exemplo, usando uma ordem ou combinação diferente de palavras no prompt de entrada.
Todos os documentos OpenAPI gerados por essa ferramenta devem ser revisados quanto à exatidão e à precisão antes de serem usados.

Gerar um documento OpenAPI a partir de uma descrição em linguagem natural

Você pode gerar um documento OpenAPI 3.0 do zero no formato JSON ou YAML, a partir de uma descrição em linguagem natural fornecida em inglês (uma ou mais frases) para a API ou o aplicativo que você gostaria de gerar. Basta iniciar seu prompt de bate-papo com Generate an openapi for.... O documento OpenAPI gerado contém esquemas de componentes relevantes para a API ou o aplicativo descrito e itens de caminho para operações de criação, recuperação, atualização e exclusão desses esquemas. Além disso, o documento gerado inclui esquemas de segurança e segurança em nível de operação recomendados por padrão, a menos que seja explicitamente solicitado a não fazê-lo.

Observação: Divida o prompt em várias frases significativas. Você pode mencionar o tipo de API que deseja gerar na primeira frase e as especificações necessárias nas frases seguintes.

Essa operação é exibida com os seguintes detalhes: O documento OpenAPI 3.0 gerado no formato JSON ou YAML (por padrão, se o formato YAML não for especificado na mensagem de prompt de entrada) que pode ser baixado.

Tabela 1. Parâmetros
Parâmetro	Obrigatório	Descrição	Padrão
`text`	True	A descrição em linguagem natural da especificação OpenAPI 3.0 a ser gerada Nota: Toda a mensagem do prompt de entrada é usada como o valor do parâmetro de texto. Ele não precisa ser referenciado explicitamente.	Nenhum
`file_format`	Não	A ferramenta Open API Generator é compatível com o formato de saída do arquivo de documento OpenAPI gerado em JSON e YAML.	YAML

Exemplos de prompts

Generate an OpenAPI spec for a weather application

Generate an OpenAPI spec for a book library application

Generate an openapi for a blog application in yaml format

Generate an OpenAPI spec for a blog application. Include operations for searching for blogs by most recommended topics. Searching for blogs should not require any authentication

Generate an OpenAPI spec for a weather application. Include an operation to provide a 7-day forecast for a given location

Genrate an OpenAPI spec for a book library application. Include operations to add and remove books from the library. Also include an operation to search the books in the library with a title

Próxima ação sugerida

Gerar código de servidor fastapi para o arquivo openapi {@filename}
Gerar código de servidor fastapi com integração de banco de dados para o arquivo openapi {@filename}