Los parámetros definen elementos variables de una vía de acceso de URL, parámetros de consulta, cabeceras o un cuerpo de solicitud. Puede crear parámetros para vías de acceso y operaciones de vía de acceso en la definición de API.
Antes de empezar
Abra la ventana de creación de parámetros. Para obtener detalles de las áreas de la definición de API donde puede crear un parámetro, consulte los temas siguientes:
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.
Un parámetro es similar a una cabecera, con las diferencias siguientes:
- Los parámetros transportan datos reales y están disponibles para los usuarios finales, mientras que las cabeceras transportan metadatos asociados con una solicitud o respuesta y están ocultas a los usuarios finales.
- Un parámetro puede tener varias ubicaciones, mientras que la ubicación de una cabecera se establece siempre en
header.
- Un parámetro puede tener varios estilos de formato, mientras que el estilo de una cabecera es siempre
simple.
En cualquier momento, puede conmutar directamente al origen YAML OpenAPI subyacente pulsando el icono Origen 
. Para volver al formulario de diseño, pulse el icono Formulario 
.
Procedimiento
- Especifique la información siguiente:
- Nombre de parámetro: el nombre del parámetro.
Nota: Cuando el nombre de un parámetro de consulta incluye el carácter especial "+", se codifica como %2B (carácter literal más) en lugar de %20 (carácter literal espacio). Por lo tanto, para cotejar el parámetro de consulta con el de entrada URL, se utiliza el valor codificado. Por ejemplo, cuando el nombre del parámetro de consulta es a+space, el valor que debe coincidir en la entrada URL es a%2Bspace.
- Ubicado en: la ubicación del parámetro. Seleccione una de las opciones que aparecen continuación:
- consulta: parámetros que se añaden al final del URL. Por ejemplo,
url_path?myparam=myvalue.
- cabecera: cabeceras personalizadas que se esperan como parte de la solicitud.
- ruta : El valor del parámetro forma parte de la operación URL, encerrada entre {}.
- body: Parámetros que describen el cuerpo de las solicitudes POST, PUT y PATCH.
- Descripción: una descripción del parámetro.
- Tipo: el tipo de datos del parámetro.
- Formato: Seleccione el formato de datos; las opciones disponibles dependen del Tiposeleccionado.
- Seleccione la siguiente opción según sea necesario:
- Necesario: determina si este parámetro es obligatorio. Si la propiedad Ubicado en se ha establecido en vía de acceso, debe seleccionarse esta opción.
- Permitir valor vacío: permite enviar un parámetro con un valor vacío. Esta opción solo es válida si la propiedad Ubicado en se ha establecido en consulta.
- Pulse Crear.