Creación de una definición de codificación

Una definición de codificación define una correlación entre una propiedad de esquema específica y su información de codificación.

Antes de empezar

Inicie la ventana de creación de definición de codificación al configurar una definición de contenido; consulte Edición de una definición de contenido.

Acerca de esta tarea

Nota:
  • Esta tarea está relacionada con la configuración de una definición de API OpenAPI 3.0. Para obtener detalles sobre cómo configurar una definición de API de OpenAPI 2.0 , consulte Edición de una definición de API de OpenAPI 2.0.
  • Las API de OpenAPI 3.0 solo están soportadas con DataPower® API Gateway, no con DataPower Gateway (v5 compatible).
  • Para obtener detalles sobre las limitaciones actuales del soporte de OpenAPI 3.0 , consulte el soporte de OpenAPI 3.0 en IBM® API Connect.

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. Especifique la información siguiente:
    • Nombre: el nombre de la propiedad de esquema.
    • Tipo de contenido: el tipo de contenido para codificar la propiedad; por ejemplo, application/xml; charset=utf-8, image/png, image/jpeg.
    • Estilo: describe cómo se serializará el valor de propiedad en función de su tipo. Seleccione una de las opciones que aparecen continuación:
      • form: Propiedades de estilo de formulario definidas 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 propiedades de formulario.
    • Explosión: si se selecciona, los valores de propiedad de tipo array u object generan propiedades separadas para cada valor de la matriz o par de clave-valor de la correlación.
    • Permitir reservado: determina si el valor de propiedad debe permitir que los caracteres reservados, tal como se define en RFC3986 (:/?#[]@!$&'()*+,;=), se incluyan sin codificación de porcentaje.
  2. Pulse Crear.
    Los detalles de la definición de codificación se muestran para su posterior edición; consulte Edición de una definición de codificación.