OpenAPI Generador

La herramienta generadora OpenAPI genera documentos OpenAPI desde cero basándose en las indicaciones que usted le proporcione.

La herramienta generadora OpenAPI puede utilizarse para generar documentos OpenAPI 3.0 en formato JSON o YAML a partir de cero, basándose en las instrucciones proporcionadas por el usuario que utiliza el Procesamiento del Lenguaje Natural (PLN). A partir de una descripción en lenguaje natural de una API o aplicación para la que el usuario desea generar un documento OpenAPI, la herramienta utiliza el modelo Granite 3 disponible en IBM watsonx para generar un documento de inicio de OpenAPI que el usuario puede tomar como base.
Nota: La herramienta genera un documento OpenAPI a partir de una descripción en lenguaje natural, mientras que la herramienta creadora de OAS genera los documentos OpenAPI a partir de un esquema de base de datos existente que añade a las fuentes del Agente API.

Detalles y limitaciones de la herramienta

A continuación se presentan los detalles y limitaciones de la herramienta Open API Generator:
  • Esta herramienta se proporciona para ayudar a los usuarios en la tarea de generar un documento OpenAPI desde cero basado en una descripción en lenguaje natural, no debe confundirse con la herramienta creadora de OAS, también disponible en API Agent, que se utiliza para generar un documento OpenAPI a partir de un esquema de base de datos existente añadido a las fuentes del Agente API.
  • Esta herramienta se basa en el modelo de base Granite 3 disponible IBM watsonx para la generación de documentos OpenAPI.
  • Dado que esta herramienta se basa en la salida del modelo de cimentación a partir de la descripción de entrada proporcionada, como todos los modelos de IA, la salida está sujeta a errores.
  • Si el documento OpenAPI generado no coincide con la descripción que se proporciona como entrada, inténtelo de nuevo y considere la posibilidad de reformular la descripción.
  • Si el documento OpenAPI generado que se muestra a partir del modelo contiene errores, como errores de especificación de OpenAPI o errores semánticos, la herramienta pasa automáticamente el documento por la operación de corrección (autocorrección) de la herramienta OpenAPI Enhancer. Si después de esta corrección sigue habiendo errores, se informará de ellos en la ventana de chat.

  • Si el documento OpenAPI generado contiene errores de sintaxis JSON o YAML que no pueden ser corregidos (autocorregidos) por la herramienta OpenAPI Enhancer, la herramienta no muestra el documento. En esta situación, el sistema muestra el siguiente mensaje: please re-phrase and try again. Intente reformular la descripción de la entrada antes de volver a intentarlo, por ejemplo, utilizando un orden o una combinación de palabras diferente en la solicitud de entrada.

  • Todos los documentos de OpenAPI generados por esta herramienta deben revisarse para comprobar su corrección y exactitud antes de ser utilizados.

Generar un documento OpenAPI a partir de una descripción en lenguaje natural

Puede generar un documento OpenAPI 3.0 desde cero en formato JSON o YAML, a partir de una descripción en lenguaje natural dada en inglés (una o varias frases) para la API o aplicación que desee generar. Sólo tiene que iniciar el chat con Generate an openapi for.... El documento OpenAPI generado contiene esquemas de componentes relevantes para la API o aplicación que se describe, y elementos de ruta para operaciones de creación, recuperación, actualización y eliminación de dichos esquemas. Además, el documento generado incluye por defecto la seguridad recomendada a nivel de operación y los esquemas de seguridad, a menos que se indique explícitamente lo contrario.

Nota: Divida la pregunta en varias frases con sentido. Puede mencionar el tipo de API que desea generar en la primera frase y las especificaciones necesarias en las siguientes.

Esta operación se muestra con los siguientes detalles El documento OpenAPI 3.0 generado en formato JSON o YAML (Por defecto, si no se especifica el formato YAML en el mensaje de solicitud de entrada) que se puede descargar.

Tabla 1. Parámetros
Parámetro Obligatorio Descripción Valor predeterminado
text Sí La descripción en lenguaje natural de la especificación OpenAPI 3.0 que debe generarse
Nota:

Como valor del parámetro de texto se utiliza el mensaje de entrada completo. No es necesario referenciarlo explícitamente.

 Ninguna
file_format Nee La herramienta Open API Generator admite el formato de salida del archivo de documento OpenAPI generado en JSON y YAML. YAML
Ejemplos de indicaciones
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 acción sugerida

  • Generar código de servidor fastapi para el archivo openapi {@filename}
  • Generar código de servidor fastapi con integración de base de datos para el archivo openapi {@filename}