Administrador del Portal

Introducción

La página Administrador de portales le permite generar documentación de OpenAPI para APIs personalizadas y de proxy. La documentación resultante se muestra en el Portal página, donde puede interactuar con ella probando APIs. Esta página describe la interfaz de usuario de la página Portal Manager dentro de API Manager.

Limitaciones

La página Administrador del portal tiene estas limitaciones:

• Generación de documentación OpenAPI para servicios OData no es compatible.
• Generación de documentación OpenAPI para servicios API utilizando un método de solicitud personalizado no es compatible debido a una limitación de la especificación OpenAPI. Las APIs que incluyen solo servicios de API de métodos personalizados se muestran solo con un nombre de etiqueta de API.
• Solo se puede crear una única página Portal para cada ambiente en una organización Harmony.

Acceda a la Página del Administrador del Portal

Se puede acceder a la página Administrador del portal desde el menú del portal Harmony o desde el menú de navegación del API Manager:

• Utilice el menú del portal Harmony para seleccionar API Manager > Administrador del portal:

  

• Al acceder a una página de API Manager, utilice su menú de navegación para seleccionar Portal Manager:

  

Encabezado de la Página del Administrador del Portal

La página Administrador del portal también se denomina Administrar el portal del desarrollador, ya que es la página donde se administra lo que aparece en el Portal página (también llamada Administrar portal para desarrolladores).

Estas opciones aparecen en la parte superior de la página Administrador del portal:

• Navegación: Utilice el menú de navegación del API Manager para navegar entre las páginas del API Manager, incluida Mis APIs, Portal, Registros de API, Análisis y Perfiles de seguridad.

• Ambiente: Utilice el menú para seleccionar el ambiente donde se generará la documentación de OpenAPI y luego se mostrará en la página del Portal de una organización.

  Para actualizar la lista de ambiente, haga clic en el botón icono de actualización.

  Nota

  Solo se puede crear una única página Portal para cada ambiente en una organización Harmony.

• Ver documentación de API: Haga clic para ir al Portal página, donde se representa la documentación API interactiva generada.

• Regenerar documentos y publicar: Haga clic para sobrescribir y publicar la documentación de OpenAPI 2.0 en la página Portal para todas las APIs personalizadas y proxy en el ambiente seleccionado. Se excluyen los servicios OData. Si ha publicado una nueva API personalizada o proxy y desea regenerar automáticamente la documentación para incluir cualquier APIs nueva, debe usar esta opción.

  Advertencia

  Al usar esta opción se sobrescribe la documentación de API existente, incluidas las personalizaciones. Antes de usar esta opción, se recomienda hacer una copia manual de la documentación de API existente copiándola en un editor de texto externo. Después de regenerar la documentación, vuelva a aplicar manualmente las personalizaciones pegándolas en el editor de documentación de API según corresponda.

• Guardar y publicar: Haga clic para guardar y publicar la documentación de la API en la página del Portal. Si ha aplicado alguna personalización a la documentación de la API generada automáticamente, debe usar esta opción para publicar la documentación en la página del Portal.

Personalizar la Página del Portal

La página Administrador del portal le permite personalizar el Portal página con una imagen, como el logotipo de una empresa, o con ediciones a la documentación de API generada automáticamente:

• Buscar archivos locales: Haz clic para seleccionar una imagen que cumpla con los requisitos enumerados:

  

  La imagen cargada se publica automáticamente en la página Portal sin necesidad de hacer clic en Regenerar documentos y publicar o Guardar y publicar.

  Para eliminar una imagen después de cargarla, haga clic en Eliminar imagen:

  

• Organización: La organización Harmony a la que se está accediendo actualmente.

• URL base: La URL base para el servicio API. Haga clic en el botón copiar icono para copiar la URL base a su portapapeles.

Editar la Documentación de la API

Documentación interactiva que sigue la Especificación OpenAPI 2.0 se genera automáticamente para todas las APIs personalizadas y de proxy en el ambiente seleccionado.

Las definiciones de OpenAPI se muestran en el editor en el lado izquierdo de la página y se representan como una IU de Swagger interactiva documentación en el lado derecho de la página.

Puede editar las definiciones de OpenAPI directamente en el editor que se encuentra en el lado izquierdo de la página. Estos son ejemplos de personalizaciones para la documentación de la API:

• Completar metadatos sobre la API, incluidos Campos fijos como title, description, termsOfService, contact, license, y version.

• Sobrescribir manualmente la documentación utilizando la Especificación OpenAPI 3.0.

Después de realizar modificaciones en la documentación de la API, haga clic en Guardar y publicar para guardar y publicar la documentación en el Portal página.

Para regenerar y publicar documentación después de publicar una nueva API, utilice el botón Regenerar documentación y publicar.

APIs de Prueba

La documentación de API generada a partir de las definiciones de OpenAPI que se muestran en el editor en el lado izquierdo de la página se representa como una IU de Swagger interactiva documentación en el lado derecho de la página. Puede utilizar el swagger interactivo para probar los servicios de la API:

• Esquemas: Utilice el menú desplegable para seleccionar entre los esquemas disponibles compatibles con las definiciones de OpenAPI.

• Autorizar: Si alguna de las APIs dentro del ambiente seleccionado requiere una autorización establecida por un perfil de seguridad asignado, se muestra un botón Autorizar. Una vez que se hace clic, aparece un cuadro de diálogo que muestra todas las autorizaciones disponibles. Complete la información según sea necesario para probar las APIs con los métodos de autorización proporcionados.

  Al hacer clic en Autorizar, se mostrará un cuadro de diálogo con las autorizaciones disponibles. Complete los datos necesarios para probar las APIs con los métodos de autorización proporcionados:

  

Servicios API

Cada servicio API se enumera con su método:

El icono de autorización indica si el servicio API requiere autorización:

• : No se requiere autorización.
• : Se requiere autorización.

Haga clic en la fila del extremo para ver información sobre sus parámetros y respuestas, que se describen a continuación.

Pruébalo

En un servicio de API expandido, haga clic en el botón Pruébelo para probar la API. Se expande una solicitud de API configurable:

• Cancelar: Haga clic para contraer la solicitud de API configurable.

• Ejecutar: Una vez configurados todos los campos de solicitud, haga clic para generar el Curl y la URL de solicitud para usar en las pruebas:

  

  • Curl: La solicitud cURL para los valores ingresados para los campos de solicitud de API. Haga clic en el copiar icono para copiar la cURL a su portapapeles.

  • URL de solicitud: La URL de solicitud para los valores ingresados en los campos de solicitud.

• Borrar: Haga clic para borrar los valores ingresados para los campos de solicitud de API.

Posibles respuestas de API : aquellas incluidas en la documentación de API – se muestran para cada servicio API:

• Respuesta del servidor: Muestra todas las respuestas del servidor documentadas.

• Respuestas: Muestra los códigos de estado HTTP documentados y sus descripciones.