Definición de parámetros para una API

Los parámetros pueden especificar elementos variables de una ruta URL, parámetros de consulta, cabeceras o el cuerpo de una solicitud.

Acerca de esta tarea

Nota: Esta tarea está relacionada con la configuración de una definición de API de OpenAPI 2.0 . Para obtener detalles sobre cómo configurar una definición de API de OpenAPI 3.0 , consulte Edición de una definición de API de OpenAPI 3.0.

Puede completar esta tarea utilizando la aplicación de interfaz de usuario de API Designer o utilizando la interfaz de usuario de API Manager basada en navegador.

En cualquier momento, puede conmutar directamente al origen YAML OpenAPI subyacente pulsando el icono Origen Icono OpenAPI Source. Para volver al formulario de diseño, pulse el icono Formulario Icono de formulario.

Procedimiento

  1. Abra la API para editarla, tal como se describe en Edición de una definición de API de OpenAPI 2.0.
  2. Si ya hay uno o más parámetros definidos, expanda Definiciones de parámetros.
  3. Puede crear un parámetro o editar cualquier parámetro existente.
    • Para crear un parámetro, pulse el icono Añadir OpenAPI 2.0 Icono de adición de API junto a Parámetrosy, a continuación, consulte Creación de un parámetro.
    • Para editar un parámetro existente, pulse el nombre del parámetro en el panel de navegación y, a continuación, consulte Edición de un parámetro.