Edición de parámetros

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 editar parámetros creados anteriormente para vías de acceso y operaciones de vía de acceso en la definición de API.

1. Especifique la información siguiente:
   • Nombre: disponible si está editando un componente de parámetro, este nombre define una clave que permite hacer referencia a este parámetro desde otra ubicación de la definición de API; la referencia tiene el formato siguiente:

     #/components/parameters/Name

     Para cambiar el nombre, pulse Actualizary, a continuación, pulse Guardar cuando haya terminado.
   • Nombre de parámetro(obligatorio): el nombre del parámetro.
   • Ubicado en (obligatorio): 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.
       • DataPower comprueba la existencia de un parámetro de consulta requerido y rechaza las peticiones que lo omiten.
       • DataPower comprueba el valor de un parámetro de consulta, pero si el parámetro se omite, no rechaza la solicitud y en su lugar genera un registro de error.
     • cabecera: cabeceras personalizadas que se esperan como parte de la solicitud.
       • DataPower comprueba la existencia de un parámetro de cabecera obligatorio y rechaza las solicitudes que lo omiten.
     • ruta : El valor del parámetro forma parte de la operación URL, encerrada entre {}.
     • cookie: se utiliza para pasar un valor de cookie específico a la API.
       • DataPower no admite el parámetro cookie.
   • Descripción: una descripción del parámetro. Puede utilizar la sintaxis CommonMark para la representación de texto enriquecido.
   • Estilo: describe cómo se serializará el valor de parámetro en función de su tipo. Seleccione una de las opciones que aparecen continuación:
     • matriz : Parámetros de la trayectoria definidos por RFC6570.
     • etiqueta : Parámetros de estilo de etiqueta definidos por RFC6570.
     • simple : Parámetros de estilo simple definidos por RFC6570.
     • formulario : Parámetros de estilo del formulario definidos por RFC6570.
     • spaceDelimited: valores de matriz separados por espacios.
     • pipeDelimited: valores de matriz separados por barras verticales.
     • deepObject: proporciona una forma sencilla de representar objetos anidados utilizando parámetros de formulario.
   • Seleccione las opciones siguientes 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.
     • En desuso: especifica que un parámetro está en desuso y debe pasar a no utilizado.
     • Permite 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.
     • Explosión: si se selecciona, los valores de parámetro de tipo array u object generan parámetros separados para cada valor de la matriz o par de clave-valor de la correlación.
     • Permitir reservados : Determina si el valor del parámetro debe permitir caracteres reservados, tal y como se definen en RFC3986 (:/?#[]@!$&'()*+,;=) sin codificación porcentual. Esta propiedad solo se aplica si la propiedad Ubicado en se ha establecido en consulta.
   • Esquema:

     Para definir un esquema para el parámetro, haga clic en Crear y consulte Creación de un componente de esquema.

     Si el parámetro ya tiene definido un esquema, pulse Ver para editarlo.

     Para más información sobre la edición de un esquema, véase Edición de un componente de esquema.

     Nota: no puede editar el esquema si hace referencia a un componente de esquema, la configuración del esquema se hereda del componente de esquema; para obtener más información sobre la configuración de un componente de esquema, consulte Definición de componentes de esquema. Sin embargo, puede editar el componente de esquema referenciado, pero los cambios se reflejarán en cualquier ubicación en la que se haga referencia al componente de esquema.
   • Valor de ejemplo: un ejemplo de un valor de parámetro. Todo lo que introduzcas aquí se mostrará tal cual en el Portal para desarrolladores.
2. Haga clic en Guardar cuando haya terminado.