Publica tus APIs (versión original)

Estás viendo la documentación de Apigee Edge.
Ve a la Documentación de Apigee X. información

Publica las API en tu portal a fin de que estén disponibles para su consumo por parte de los desarrolladores de apps, como se describe en las siguientes secciones.

Descripción general de la publicación de API

El proceso de publicación de API en tu portal es un proceso de dos pasos:

  1. Selecciona el producto de API que deseas publicar en tu portal.
  2. Generar automáticamente documentación de referencia de la API a partir de una instantánea de tu especificación de OpenAPI para que los desarrolladores de apps puedan obtener información sobre tus APIs. (Para obtener más información sobre las instantáneas, consulta ¿Qué es una instantánea de una Especificación de OpenAPI?

Cuando publicas una API en tu portal, se realizan automáticamente las siguientes actualizaciones:

  • Se agregará una página de referencia de la API a tu portal
    En la página Referencia de la API, se muestra la documentación de referencia de la API que generas automáticamente a partir de una instantánea de tu especificación de OpenAPI. Los desarrolladores pueden revisar la documentación de tu API y hacer clic en Probar para realizar una solicitud a la API y ver el resultado.

    Nota: No puedes editar el contenido de esta página directamente. no aparece en la lista de páginas de tu portal.

  • Se agrega un vínculo a la página Referencia de la API en la página de la API
    La página de APIs (incluida con el portal de muestra) proporciona una lista de todas las APIs publicadas en tu portal con vínculos a la documentación de referencia de la API correspondiente para obtener más información.

    Nota: No puedes editar el contenido de esta página directamente. no aparece en la lista de páginas de tu portal.

¿Qué es una instantánea de una Especificación de OpenAPI?

Cada Especificación de OpenAPI sirve como fuente de información a lo largo del ciclo de vida de una API. Se usa la misma especificación en cada fase del ciclo de vida de la API, desde el desarrollo hasta la publicación y la supervisión. Cuando modificas una especificación, debes conocer el efecto que los cambios tienen en tu API a través de otras fases del ciclo de vida, como se describe en ¿Qué sucede si modificas una especificación?

Cuando publicas tu API, tomas una instantánea de OpenAPI Specification para generar documentación de referencia de la API. Esa instantánea representa una versión particular de la especificación en el almacén de especificaciones. Si modificas la especificación de OpenAPI con el editor de especificaciones, puedes tomar otra instantánea de la especificación para reflejar los cambios más recientes en la documentación de referencia de la API.

Agrega compatibilidad con CORS a los proxies de tu API

Antes de publicar tus APIs, deberás agregar compatibilidad con CORS a los proxies de tus APIs para admitir las solicitudes de origen cruzado del cliente.

El CORS (uso compartido de recursos entre dominios) es un mecanismo estándar que permite que las llamadas XMLHttpRequest (XHR) de JavaScript que se ejecutan en una página web interactúen con recursos de dominios sin origen. CORS es una solución implementada con frecuencia en la política del mismo origen que aplican todos los navegadores. Por ejemplo, si realizas una llamada XHR a la API de Twitter desde el código JavaScript que se ejecuta en tu navegador, la llamada fallará. Esto se debe a que el dominio que entrega la página a tu navegador no es el mismo que el dominio que entrega la API de Twitter. CORS brinda una solución a este problema, ya que permite que los servidores acepten la si quieren ofrecer uso compartido de recursos entre dominios.

Si deseas obtener información para agregar compatibilidad con CORS a los proxies de tu API antes de publicar las APIs, consulta Cómo agregar compatibilidad con CORS a un proxy de API.

Nota: La mayoría de los navegadores modernos aplican CORS. Consulta la lista completa de navegadores compatibles. Para obtener una descripción detallada de CORS, consulta la Recomendación de W3C de uso compartido de recursos entre dominios.

Explora la página de APIs

Para acceder a la página de APIs, haz lo siguiente:

  1. Selecciona Publicar > Portales y selecciona tu portal.
  2. En la página principal del portal, haz clic en APIs.

También puedes seleccionar APIs en el menú desplegable del portal en la barra de navegación superior.

Se muestra la lista de APIs.

Referencia de API

Como se destaca en la figura anterior, la página de APIs te permite hacer lo siguiente:

Agrega una API a tu portal

Nota: Puedes agregar un máximo de 100 APIs a tu portal.

Para agregar una API a tu portal, sigue estos pasos:

  1. Selecciona Publicar > Portales y selecciona tu portal.
  2. En la página principal del portal, haz clic en APIs.
    Como alternativa, puedes seleccionar APIs en el menú desplegable del portal en la barra de navegación superior.
  3. Haz clic en + API.
    Aparecerá el diálogo Add API Product to Portal.

  4. En la pestaña Producto API del cuadro de diálogo, selecciona el producto de API que deseas agregar a tu portal.

  5. Haz clic en Siguiente.

  6. Selecciona el origen que usar para la instantánea.
    Si creaste el proxy de API incluido en el producto de API con una especificación de OpenAPI, selecciónala en la lista desplegable.
    Agregar instantánea

    Como alternativa, puedes seleccionar las siguientes opciones:

  7. Selecciona la casilla de verificación Publicado para publicar la API en tu portal. Anula la selección de Publicado si no tienes todo listo para publicar la API.
    Puedes cambiar la configuración más adelante, como se describe en Cómo publicar o anular la publicación de una API en tu portal.

  8. En Público, selecciona una de las siguientes opciones para permitir el acceso y administrar el público de tu API:

    • Usuarios anónimos para que todos los usuarios vean la página.
    • Usuarios registrados para que solo los usuarios registrados vean la página.

    Puedes cambiar el parámetro de configuración más adelante, como se describe en Cómo administrar el público de una API en tu portal.

  9. Haz clic en Finalizar.

Toma una instantánea de la especificación

Después de publicar tu API, puedes realizar una nueva instantánea de la Especificación de OpenAPI para actualizar la documentación de referencia de la API que está publicada en tu portal en cualquier momento.

Para tomar una instantánea de OpenAPI Specification, haz lo siguiente:

  1. Selecciona Publicar > Portales y selecciona tu portal.
  2. Haz clic en APIs en la página principal del portal.
    Como alternativa, puedes seleccionar APIs en el menú desplegable del portal en la barra de navegación superior.
  3. Coloca el cursor sobre la API de la que deseas tomar una instantánea para mostrar las acciones.

  4. Haga clic en Ícono de instantánea.

    Nota: Si la instantánea está actualizada con la especificación de origen seleccionada, aparecerá un mensaje.

  5. Selecciona una especificación existente del menú desplegable Fuente de la instantánea o selecciona Elegir una especificación diferente para seleccionar o subir una especificación nueva y usarla para generar documentación para la API. También puedes seleccionar Sin especificación para quitar la especificación actual.

  6. Haz clic en Update Snapshot (o Remove Snapshot, si seleccionaste Sin Spec).

La documentación de referencia de la API se genera a partir de la especificación y se agrega a la página Referencia de la API.

Publica o anula la publicación de una API en tu portal

Publica o anula la publicación de una API en tu portal

  1. Selecciona Publicar > Portales y selecciona tu portal.
  2. Haz clic en APIs en la página principal del portal.
    Como alternativa, puedes seleccionar APIs en el menú desplegable del portal en la barra de navegación superior.
  3. Coloca el cursor sobre la API que quieres publicar o anular.
  4. Haga clic en Ícono de configuración.
  5. Selecciona la casilla de verificación Habilitada para publicar la API en tu portal. Anula la selección de Habilitada para anular la publicación de la API.
  6. Haz clic en Guardar.

Administra el público de una API en tu portal

Para administrar el público de tu API en el portal, permite el acceso a lo siguiente:

  • Todos los usuarios
  • Solo los usuarios registrados

Para administrar el público de una API en tu portal, haz lo siguiente:

  1. Selecciona Publicar > Portales y selecciona tu portal.
  2. Haz clic en APIs en la página principal del portal.
    Como alternativa, puedes seleccionar APIs en el menú desplegable del portal en la barra de navegación superior.
  3. Coloca el cursor sobre la API para la que deseas administrar el público a fin de mostrar las acciones.
  4. Haz clic en Ícono de configuración.
  5. En Público, selecciona una de las siguientes opciones:
    • Usuarios anónimos para permitir que todos los usuarios vean el producto de API
    • Usuarios registrados, para permitir que solo los usuarios registrados vean el producto de API.
  6. Haz clic en Guardar.

Quita una API de tu portal

Para quitar una API de tu portal, sigue estos pasos:

  1. Selecciona Publicar > Portales y selecciona tu portal.
  2. Haz clic en APIs en la página principal del portal.
    Como alternativa, puedes seleccionar APIs en el menú desplegable del portal en la barra de navegación superior.
  3. Coloca el cursor sobre la API de la lista para ver el menú de acciones.
  4. Haz clic en Borrar.

Soluciona problemas con tus APIs publicadas

Cuando uses esta función, si se muestra el error TypeError: Failed to fetch, considera las siguientes causas y soluciones posibles:

  • En el caso de los errores de contenido mixto, el error puede deberse a un problema conocido de una IU de Swagger. Una posible solución es asegurarte de especificar HTTPS antes de HTTP en la definición schemes en la especificación de OpenAPI. Por ejemplo: 

     schemes:
   - https
   - http

  • En el caso de los errores de restricción de CORS (uso compartido de recursos entre dominios), asegúrate de que CORS sea compatible con los proxies de tu API. CORS es un mecanismo estándar que habilita las solicitudes de orígenes cruzados del cliente. Consulta Agrega compatibilidad con CORS para un proxy de API. Asegúrate de que CORS también esté habilitado en tu navegador.