Paso 6: Publicar una API

Estás consultando la documentación de Apigee Edge.
Consulta la documentación de Apigee X. Información

En este paso, realizarás los siguientes pasos para publicar una API en el portal:
1. Crea una especificación de OpenAPI.
2. Crea un proxy de API a partir de una especificación.
3. Crea un producto de API.
4. Publica la API en tu portal

Paso 1: Crea una especificación de OpenAPI

Cada especificación de OpenAPI es la fuente de información durante todo el ciclo de vida de la API. Se usa la misma especificación en cada fase del ciclo de vida de la API, desde el desarrollo hasta la publicación.

Para crear una especificación de OpenAPI, haz lo siguiente:

  1. Selecciona Develop > Specs en la barra de navegación izquierda para abrir la página Specs.
  2. Haz clic en + Especificaciones > Importar URL.
  3. Ingresa la siguiente información en el diálogo de importación:
  4. Nombre de la importación: helloworld

  5. URL de importación: https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget.yaml

  6. Haz clic en Importar.

Paso 2: Crea un proxy de API a partir de una especificación

Crea un proxy de API a partir de una especificación de OpenAPI que describe la API.

Para crear un proxy de API a partir de una especificación de OpenAPI, sigue estos pasos:

  1. En la página Especificaciones, coloca el cursor sobre la especificación de helloworld para mostrar el menú de acciones.
  2. Haz clic en para generar un proxy de API a partir de la especificación.
    Se abrirá el asistente Build a Proxy y se prepropagará la página Detalles con valores de la especificación de OpenAPI.
  3. Edita el campo Descripción (Description) de la siguiente manera: proxy de API para Hello World.
  4. Haga clic en Next.

  5. En la página Políticas (Policies), haz lo siguiente:

    • En Seguridad: autorización (Security: Authorization), selecciona Pasar (sin autorización) (Pass through [no authorization]).
    • En Seguridad: navegador (Security: Browser), selecciona Agregar encabezados de CORS (Add CORS headers).

    Página de políticas comunes en el asistente de creación del proxy con las opciones Pasar y Agregar encabezados de CORS seleccionadas

  6. Haz clic en Siguiente.

  7. En la página Flujos (Flows), asegúrate de que todas las operaciones estén seleccionadas y haz clic en Siguiente (Next).
    Compila flujos de proxy

  8. En la página Virtual Hosts, asegúrate de que todos los hosts virtuales estén seleccionados y haz clic en Next.

  9. En la página Resumen (Summary), selecciona el entorno en el que deseas realizar la implementación en Implementación opcional (Optional Deployment).

  10. Haz clic en Crear.

En la página Resumen, verás una confirmación de que tu nuevo proxy de API se creó correctamente y se implementó en tu entorno de pruebas.

Paso 3: Crea un producto de API

Crea un producto de API que contenga los recursos de API que quieres exponer a los consumidores de API.

Para crear un producto de API, haz lo siguiente:

  1. Selecciona Publish > API Products en la barra de navegación izquierda para abrir la página Productos de API (API Products).
  2. Haz clic en +API Product.
    Se mostrará la página Prodcuto nuevo.
  3. Ingresa los detalles del producto para el producto de API.
    Nota: Según la configuración predeterminada, los campos Nombre visible y Descripción se muestran en el portal cuando publicas el producto de API. Puedes editar los valores en el Paso 4: Publica la API en tu portal.
    Campo Valor
    Nombre Hello World
    Nombre visible Hello World
    Descripción Ejemplo simple de Hello World
    Entorno Selecciona el entorno en el que se implementa el proxy de API.
    Acceso Pública
    Aprueba de manera automática las solicitudes de acceso Habilitada
    Cuota (déjalo en blanco)
    Permisos de OAuth permitidos (déjalo en blanco)
  4. En Recursos de API, haz clic en Agregar un proxy para identificar los proxies de API que se agregarán a tu producto de API.
    Aparecerá el cuadro de diálogo Add API Resource.
  5. Haz clic en API Proxy (si todavía no está seleccionado) y selecciona Mock-Target-API en la lista.
  6. Haz clic en Agregar.
  7. Haz clic en Save para guardar el producto de API.

    Producto de la API de Hello World que muestra todos los campos configurados

Paso 4: Publica la API en tu portal

Publica la API en el portal para permitir que tus clientes obtengan información acerca de esta y la usen.

Para publicar la API en el portal, sigue estos pasos:

  1. Navega a la página de las API en el portal:
    1. Selecciona Publish > Portals en la barra de navegación izquierda.
    2. Haz clic en la fila My first portal para abrir el portal.
    3. Haz clic en Catálogo de API para mostrar la página de las APIs.
  2. Haz clic en +.
  3. Selecciona Hello World en el cuadro de diálogo Add an API product to the catalog y haz clic en Next.
  4. En Detalles de la API (API details), configura las siguientes opciones:
    • Selecciona Publicada (enumerada en el catálogo) (Publish [listed in the catalog]) para publicar la API en tu portal.
    • En Mostrar imagen (Display image), haz lo siguiente:
      1. Haz clic en Select image.
      2. Haz clic en home-background.jpg de la lista de imágenes existentes en el diálogo Seleccionar imagen.
      3. Haz clic en Seleccionar.
      4. Obtén una vista previa de la imagen y haga clic en Select.
    • En Categorías (Categories), ingresa Comenzar (Get Started) y presiona Enter.

    Deja todos los demás valores con su configuración predeterminada.

  5. En Documentación de la API (API documentation), para generar de forma automática la documentación de referencia de la API a partir de una instantánea de la especificación de OpenAPI, haz lo siguiente:
    1. Selecciona Documento de OpenAPI.
    2. Haz clic en Seleccionar documento.
    3. Selecciona la pestaña My Specs (si todavía no está seleccionada).
    4. Selecciona helloworld de la lista de especificaciones.
    5. Haz clic en Seleccionar.
  6. Haz clic en Guardar para guardar los detalles de la API.

    API de Hello World que muestra todos los campos configurados

Para ver la documentación de referencia de la API, sigue estos pasos:

  1. Haz clic en Live Portal para ver los cambios en el portal en vivo (o actualízalo si ya está abierto en otra pestaña).
  2. Haz clic en API en la barra de navegación superior para ver la API publicada.
  3. Haz clic en la tarjeta Hello World para ver la documentación de referencia de la API. Prueba tu API

API de destino ficticio publicada con el panel Prueba esta API

¡Felicitaciones! Completaste el instructivo correctamente. ¿Deseas obtener más información? Ve a Compila tu portal integrado.