OpenAPI Potenciador

Editar en línea

La herramienta OpenAPI Enhancer mejora sus API generando recomendaciones inteligentes de descripciones y ejemplos. También ayuda a identificar errores de validación y posibles problemas que puedan afectar a la corrección de la API.

La herramienta OpenAPI Enhancer se comunica con API Agent. Después de introducir una solicitud y hacer clic en Enviar en API Agent, se muestra un plan propuesto. Para iniciar la mejora de la especificación o la autocorrección de OpenAPI,, haga clic en Iniciar. Una vez finalizado el proceso, podrá descargar el archivo OpenAPI mejorado.

Aspectos más destacados
  • Mejore su documentación OpenAPI 3.0 generando recomendaciones para sus descripciones y ejemplos.
  • Mejora su especificación OpenAPI 3.0 mediante la identificación de errores de validación y la generación de posibles correcciones.
La herramienta OpenAPI Enhancer permite realizar las siguientes operaciones:
Tabla 1. Parámetros
Parámetro Obligatorio Descripción Valor predeterminado
input_file Nee La especificación OpenAPI en formato YAML o JSON. Ninguna
api Nee El nombre del borrador de la API. Ninguna
version Nee La versión preliminar de la API. Ninguna
file_format Nee El formato del archivo OpenAPI generado que se muestra, ya sea JSON o YAML. YAML
oai_feature_type Sí Seleccione el tipo de mejora GenAI que desea aplicar, ya sea sugerir mejoras o corregir automáticamente el contenido. Ninguna

Mejoras en las especificaciones

Mejore su documentación en OpenAPI analizando la definición de la API y generando recomendaciones para sus descripciones y ejemplos.

Ejemplos de indicaciones
Augment the following openapi with enhanced descriptions and examples @openapi-sample.yaml

O desde un borrador de API (con nombre de API: versión)

Augment the following openapi with enhanced descriptions and examples openapi-sample:1.0.0
Nota: Seleccione el archivo deseado, por ejemplo, openapi-sample.yaml. Si introduce @ después de la pregunta, aparecerá una lista de los documentos OpenAPI disponibles en su espacio de trabajo.

Errores de validación de especificaciones

Mejore sus API analizando su especificación OpenAPI 3.0 y generando posibles correcciones de API para cualquier error de validación.

Ejemplos de indicaciones
Correct the validation errors in the following openapi file @openapi-sample.yaml

O desde un borrador de API (con nombre de API: versión)

Correct the validation errors in the following openapi file openapi-sample:1.0.0
Nota: Por defecto, el formato del documento OpenAPI aumentado es YAML. Si necesita que su documento OpenAPI esté en formato JSON, especifíquelo claramente en la consulta.

Estas funciones de API Agent también están disponibles en la interfaz de usuario del API Manager.