Establecimiento de propiedades de API

Además de las propiedades de API proporcionadas previamente que puede utilizar para controlar el comportamiento de las políticas de API Connect , puede definir sus propias propiedades de API. Se puede hacer referencia a las propiedades que defina en las definiciones de API.

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.

Las propiedades de API incluyen el nombre de propiedad, el valor y, opcionalmente, un catálogo específico al que se aplica un valor de propiedad. Para obtener una lista de propiedades de API proporcionadas previamente relacionadas con diversas políticas, consulte Propiedades de API.
Nota: Una vez definida, una propiedad de API es de sólo lectura.

Para obtener información sobre cómo hacer referencia a una propiedad en una definición de API, consulte Referencias a variables en API Connect.

También es posible definir propiedades que son específicas de un catálogo y a las que puede hacer referencia cualquiera de las API de dicho catálogo; para obtener más información, consulte Creación y configuración de catálogos. Tenga en cuenta que si define una propiedad de catálogo con el mismo nombre que una propiedad de API, la propiedad de API tiene prioridad sobre la propiedad de catálogo.

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.

Sugerencia: Si añade o cambia una propiedad de API en una API que ya está desplegada o publicada, debe volver a transferir o publicar el producto que contiene la API actualizada para que el cambio entre en vigor.

Procedimiento

  1. Abra la API para editarla, tal como se describe en Edición de una definición de API de OpenAPI 3.0.
  2. Seleccione el separador Pasarela , expanda Valores de pasarela y portal y, a continuación, si ya hay una o más propiedades de API definidas, expanda Propiedades.
  3. Configure una propiedad de API.
    • Para definir una nueva propiedad de API, siga estos pasos:
      1. Pulse el icono Añadir OpenAPI 3.0 Icono de adición de API junto a Propiedades en el panel de navegación.
      2. Especifique la información siguiente:
        • Nombre de propiedad: especifique un nombre para la propiedad; este nombre se utilizará para hacer referencia a la propiedad. El juego de caracteres siguiente está soportado para el Nombre de una propiedad de API: [A-Za-z0-9_-]+. Se permiten espacios.
        • Valor: un valor predeterminado para la propiedad. Déjelo en blanco si la propiedad debe tener un valor nulo de forma predeterminada.
        • Descripción: descripción opcional de la propiedad. Puede utilizar la sintaxis CommonMark para la representación de texto enriquecido.
        • Seleccione Codificado si desea ocultar los valores de propiedad o evitar que las contraseñas de usuario se vean por casualidad.
          Nota: Si codifica un valor de propiedad, se guarda en formato codificado Base64 ; no se cifra. Si después quita la marca del recuadro de selección Codificado, el valor de propiedad original se restaura en el formato no codificado correspondiente.
      3. Pulse Crear.
    • Para modificar una propiedad de API existente, pulse el nombre de la propiedad en el panel de navegación. A continuación, puede cambiar cualquiera de los valores de configuración.
  4. Pulse Guardar para guardar los cambios.

Qué hacer a continuación

Opcionalmente, defina un valor para la propiedad que es específica de un catálogo determinado; consulte Definición de valores de propiedad específicos del catálogo.