Definición de parámetros para una API

Editar en línea

Los parámetros pueden especificar elementos variables de una ruta de acceso de un URL, parámetros de consulta, encabezados o un cuerpo de 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, puedes pasar directamente al código fuente YAML de « OpenAPI » haciendo clic Icono OpenAPI Source en el icono «Fuente ». Para volver al formulario de diseño, haz clic en el icono del 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, haz clic en el icono de añadir OpenAPI 2.0 Icono de adición de API situado junto a «Parámetros » y, a continuación, consulta la sección «Creación de un parámetro ».
    • Para editar un parámetro existente, haz clic en el nombre del parámetro en el panel de navegación y, a continuación, consulta la sección «Edición de un parámetro ».