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

Editar en línea

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

Al configurar una definición de contenido, abra la ventana de creación de definiciones de codificación; 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, 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. 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:
      • formulario : Propiedades de estilo del formulario definidas en 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 caracteres reservados : Determina si el valor de la propiedad debe permitir la inclusión de caracteres reservados, tal y como se definen en RFC3986 (:/?#[]@!$&'()*+,;=), sin necesidad de codificación por porcentaje.
  2. Pulse Crear.
    Se muestran los detalles de la definición de codificación para poder editarlos; consulte «Edición de una definición de codificación ».