Especificación de valores de pasarela y portal

Editar en línea

Defina valores generales de configuración de la API.

Acerca de esta tarea

Nota: Esta tarea está relacionada con la configuración de una definición de API de OpenAPI 2.0 . Para obtener detalles sobre cómo configurar una definición de API de OpenAPI 3.0 , consulte Edición de una definición de API de OpenAPI 3.0.

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. Abra la API para editarla, tal como se describe en Edición de una definición de API de OpenAPI 2.0.
  2. Seleccione el separador Pasarela y, a continuación, pulse Valores de pasarela y portal.
  3. Especifique la información siguiente:
    • Servicios de destino: Defina los servicios web que desea utilizar en la definición de API. Para obtener más información, consulte «Definición de servicios de destino para una API ».
    • Aplicado: Seleccione esta opción para imponer la API utilizando DataPower® API Gateway. Deseleccione esta opción si está gestionando la API en una pasarela que no sea DataPower API Gateway. Aunque no se haya publicado en una pasarela, API Connect una API sin aplicar sigue estando disponible en el Catálogo de consumidores para que los desarrolladores de aplicaciones puedan suscribirse a ella.
    • Fase: la fase del ciclo de vida en la que se encuentra la API; seleccione una de las opciones siguientes:
      • Realizado (valor predeterminado)- La API está en la fase de implementación.
      • Identificado - La API se encuentra en la fase conceptual temprana y no está totalmente diseñada ni implementada.
      • Especificado - La API se ha diseñado completamente y ha pasado un hito interno pero todavía no se ha implementado.
    • Comprobable : Selecciona esta opción para permitir que las operaciones de la API se prueben mediante la herramienta de pruebas del Catálogo de consumidores.
      Nota: Para que la herramienta de prueba funcione, se debe incluir una API en un plan en un producto que está desplegado en un catálogo.
    • CORS: habilitar y configurar el soporte de CORS (uso compartido de recursos de diversos orígenes) para la API. Para obtener más información, consulta «Habilitar la compatibilidad con CORS para una API ».
    • Propiedades: añada propiedades a las que pueda hacerse referencia en la definición de API. Para obtener más información, consulta «Configuración de las propiedades de la API ».
    • Propiedades de catálogo: defina valores de propiedad que sean específicos de un catálogo determinado. Para obtener más información, consulte «Definición de valores de propiedades específicos del catálogo ».
    • Puerta de enlace : Para obtener más información, consulte «Especificación del tipo de puerta de enlace para una definición de API ».
    • Autenticación de aplicación: habilite la autenticación de aplicación para proteger la API con un certificado. Para obtener más información, consulta «Configuración de la autenticación de aplicaciones para una API ».
    • Origen de autenticación de aplicación: Si la autenticación de aplicación está habilitada, especifique cómo se envía el certificado de cliente a la pasarela. Para obtener más información, consulta «Configuración de la autenticación de aplicaciones para una API ».
    • Registro de actividad: configure las preferencias de registro para la actividad de API que se almacena en el Análisis. Para obtener más información, consulte «Configuración del registro de actividades ».
    • Página Html: para una API GraphQL , la página HTML con la que la API responde a una solicitud inicial del editor GraphiQL . Actualmente, la única opción es store:///graphiql.html. Para obtener más información, consulte «Habilitar el editor de « GraphiQL » para una API de « GraphQL ».
    • Esquema Graphql: para una API GraphQL , el nombre de la definición de esquema que hace referencia al esquema GraphQL importado. Para obtener información sobre cómo cargar un esquema durante la creación de una API de « GraphQL », consulta Creación de una API proxy de « GraphQL ». Para obtener información sobre cómo sustituir el esquema de una API de « GraphQL » ya existente, consulta «Uso del editor de esquemas de GraphQL ».
    • Exxtensiones: se han añadido extensiones a la API para ampliar la especificación OpenAPI . Para obtener más información, consulta «Añadir una extensión de OpenAPI a una API ».