Definición de servidores para una API

Las definiciones de servidor en una API proporcionan información para conectarse a los servidores de destino.

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.

Puede definir más de un servidor, pero sólo el primero lo utiliza API Connect.

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

Abra la API para editarla, tal como se describe en Edición de una definición de API de OpenAPI 3.0.
Expanda General y, si ya hay uno o más servidores definidos, expanda Servidores.
Para crear una nueva definición de servidor, pulse el icono Añadir junto a Servidores en el panel de navegación. Para editar una definición de servidor existente, pulse el URL del servidor en el panel de navegación.
Especifique la información siguiente:
- URL de servidor (obligatorio): El URL especificado se utiliza para determinar el punto final de URL completo para llamar a la API, teniendo en cuenta la configuración de puntos finales de vanidad del catálogo en el que se publica la API. Para una API impuesta por DataPower API Gateway, el valor especificado aquí se interpreta como la vía de acceso base, por lo que normalmente solo proporcionaría el valor de vía de acceso base; por ejemplo:
```
/my_basepath
```
  Para obtener más información sobre cómo se utiliza el servidor URL para determinar el punto final completo de URL, consulte Configuración de puntos finales de vanidad para un catálogo.
- Descripción de servidor: Descripción opcional del host designado por el URL. Puede utilizar la sintaxis CommonMark para la representación de texto enriquecido.
- Variables de servidor (disponible al editar una definición de servidor existente): una variable de servidor define una correlación entre un nombre de variable y su valor. El valor se utiliza para la sustitución en la plantilla de URL del servidor.
  1. Para añadir una nueva variable de servidor, pulse Añadir. Para editar una variable de servidor existente, pulse el nombre de la variable.
  2. Especifique la información siguiente:
    - Nombre de variable de servidor (obligatorio).
    - Valor predeterminado (obligatorio).
    - Una descripción opcional de texto enriquecido. Puede utilizar la sintaxis CommonMark para la representación de texto enriquecido.
    - Una o varias entradas Valor enum (disponibles al editar una variable de servidor existente). Los valores de enumeración (enum) especifican una enumeración de valores de serie que deben utilizarse si las opciones de sustitución proceden de un conjunto limitado. Para añadir un nuevo valor de enumeración, pulse Añadir, especifique el valor y pulse Crear. Para editar un valor de enumeración existente, pulse el valor de enumeración.
  3. Si está creando una variable de servidor, pulse Crear. Se visualizan los detalles de la variable de servidor para editarlos con mayor detalle.
  4. Si es necesario, utilice la indicación de ruta para volver a la definición del servidor y editarla con mayor detalle.
Si está creando una nueva definición de servidor, pulse Crear.
Los detalles de definición de servidor se muestran para su posterior edición, tal como se describe en el paso 4.
Haga clic en Guardar cuando haya terminado.