Ejercicio: Creación de un documento de OpenAPI

  • 20 minutos

El departamento de ventas necesita un agente que responda a sus preguntas mediante la información de los datos. Aquí, se crea una especificación de API que necesita para integrar el agente con la acción de API. Valida cómo funciona según los requisitos para comprobar el trabajo.

Especificación

Tiene una especificación de OpenAPI para la API.

Especificación de API:

  • Solo contiene las operaciones pertinentes.
  • Incluye descripciones pertinentes para explicar el propósito de cada operación y parámetro.

Comprobar el trabajo

En este momento, tiene una especificación de OpenAPI para la API. La API contiene la información necesaria que debe usar el agente declarativo.

  • Tiene una especificación openAPI válida en JSON o YAML.
  • La especificación de API solo contiene las operaciones pertinentes.
  • Cada operación de la especificación de la API incluye un resumen y una descripción significativos.
  • Cada parámetro incluye una descripción significativa.
  • En cada respuesta, cada propiedad incluye una descripción significativa.