Página del Administrador del Portal en Jitterbit API Manager

Introducción

La página del Administrador del Portal permite generar documentación OpenAPI para todas las APIs personalizadas y proxy en un entorno a la vez. La documentación resultante se muestra en la página del Portal de API, donde se puede interactuar con ella probando las APIs. Para generar documentación para una API individual en su lugar, utiliza la pestaña Documentación en la página de APIs. Esta página describe la interfaz de usuario de la página del Administrador del Portal dentro del API Manager.

Limitaciones

La página del Administrador del Portal tiene estas limitaciones:

• La generación de documentación OpenAPI para APIs OData no es compatible al usar Regenerar Docs. Para generar documentación para una API OData individual, utiliza la pestaña Documentación en la página de APIs.
• La generación de documentación OpenAPI para servicios de API que utilizan 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étodo personalizado se muestran con un nombre de etiqueta de API únicamente.
• Solo se puede crear una única página de Portal de API para cada entorno en una organización Harmony.

Acceder a la página del Administrador del Portal

Para acceder a la página del Administrador del Portal, utiliza el menú del portal Harmony para seleccionar API Manager > Administrador del Portal.

Editor OpenAPI

El Editor de OpenAPI incluye los siguientes controles:

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

  Nota

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

• Carga de logo: Puedes personalizar la página del Portal de API arrastrando y soltando una imagen en la zona de carga o seleccionando una manualmente. Tu carga se publica automáticamente en la página del Portal de API sin necesidad de hacer clic en Regenerar Docs o Guardar y Publicar.

• Regenerar Docs: Haz clic para sobrescribir y publicar la documentación de OpenAPI 2.0 en la página del Portal de API para todas las APIs personalizadas y proxy en el entorno seleccionado. Las APIs OData están excluidas. Si has publicado una nueva API personalizada o proxy y deseas regenerar automáticamente la documentación para incluir cualquier nueva API, debes utilizar esta opción.

  Advertencia

  Usar esta opción sobrescribe la documentación de API existente, incluidas cualquier personalización. 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, vuelve a aplicar manualmente cualquier personalización pegándola en el editor de documentación de API según corresponda.

• Guardar y Publicar: Haz clic para guardar y publicar la documentación de API en la página del Portal de API. Si has aplicado alguna personalización a la documentación de API generada automáticamente, debes utilizar esta opción para publicar la documentación en la página del Portal de API.

• Editor: Cuando agregas definiciones de OpenAPI en el editor, se renderizan como documentación interactiva de Swagger UI en la Vista Previa del Portal. Puedes editar las definiciones de OpenAPI directamente dentro del editor. Estos son ejemplos de personalizaciones para la documentación de API:

  • Rellena los metadatos sobre la API, incluyendo Campos Fijos como title, description, termsOfService, contact, license, y version.

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

  Después de realizar ediciones en la documentación de la API, haz clic en Guardar y Publicar para guardar y publicar la documentación en la página del Portal de API.

Vista Previa del Portal

Puedes ver las definiciones de la API como documentación interactiva de Swagger UI en la Vista Previa del Portal.

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

• Buscar: Ingresa un nombre de API, nombre de servicio o método para filtrar las APIs Disponibles a aquellas que coincidan con la consulta.

• URL Base: La URL base para el servicio de API. Haz clic en el ícono de copiar para copiar la URL base en tu portapapeles.

• APIs Disponibles: Agrupa tus servicios de API por la raíz del servicio, por ejemplo, book o loan. Haz clic en las flechas para expandir o colapsar las APIs en ese grupo. Usa Expandir/Colapsar todo para mostrar u ocultar la lista de APIs.

  

Probar APIs

Cuando seleccionas un endpoint de API, su documentación interactiva de Swagger UI aparece en el lado derecho de la página. Puedes usar el Swagger interactivo para probar los servicios de API.

• Autorizar: Si alguna de las APIs dentro del entorno seleccionado requiere una autorización establecida por un perfil de seguridad asignado, se muestra un botón de Autorizar. Cuando haces clic en Autorizar, se muestra un diálogo con las autorizaciones disponibles. Completa la entrada según sea necesario para probar las APIs con los métodos de autorización proporcionados.

  

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

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

• Prueba: Haz clic para probar la API. Se expande una solicitud API configurable:

  

  • Cancelar: Haz clic para colapsar la solicitud API configurable.

  • Ejecutar: Después de configurar los campos de la solicitud, haz clic en este botón para generar el Curl y la URL de solicitud que se utilizarán para la prueba.

    

  • Curl: La solicitud cURL para los valores ingresados en los campos de la solicitud API. Haz clic en el ícono para copiar el cURL en tu portapapeles.

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

  • Limpiar: Haz clic para limpiar los valores ingresados en los campos de la solicitud API.

Cada servicio API muestra posibles respuestas API que están incluidas en la documentación de la API:

• Respuesta del servidor: Muestra cualquier respuesta del servidor documentada.

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