Paso 6: Publicar una API

Esta página se aplica a Apigee y Apigee Hybrid.

Consulta la documentación de Apigee Edge.

En este paso, publicarás una API en el portal mediante los siguientes pasos:

  1. Crear un proxy de API a partir de una especificación
  2. Crear un producto de API
  3. Publicar la API en el portal

Paso 1: Crear 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 IU de Apigee, selecciona Desarrollar > Proxies de API en la barra de navegación izquierda para abrir la página Proxies de API.

  2. Haz clic en Crear nueva (Create New).
    Agrega el proxy de API

    Se abrirá el asistente de Creación de proxy (Create Proxy) y te solicitará que selecciones el tipo de proxy de API que deseas crear.

  3. En Proxy inverso (más común) (Reverse Proxy [most common]), haz clic en Use OpenAPI Spec (Usar una especificación de OpenAPI).Usar una especificación de OpenAPI

    Aparecerá el cuadro de diálogo Usar OpenAPI Spec.

  4. Copia y pega la siguiente URL en el campo OpenAPI Spec URL, en la pestaña URL:

    https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget3.0.yaml

  5. Haz clic en Seleccionar.
    El asistente de creación de proxy se abre y la página Detalles del proxy se propaga de forma previa con valores de la Especificación de OpenAPI.

    Página de detalles del proxy en el asistente de creación del proxy propagada previamente con contenido

  6. Edita el campo Descripción (Description) de la siguiente manera: proxy de API para Hello World.

  7. Haz clic en Siguiente.

  8. 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

  9. Haz clic en Siguiente.

  10. 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

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

  12. Haz clic en Crear e implementar (Create and deploy).

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

Paso 2: Crear 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. En la IU de Apigee, selecciona Publicar > Productos de API en la barra de navegación izquierda para abrir la página Productos de API.
  2. Haz clic en +CREAR.
    Se mostrará la página Producto.
  3. Ingresa los detalles del producto para el producto de API.
    Nota: Los campos Display Name y Description se muestran en el portal cuando publicas el producto de API de forma predeterminada. Puedes editar los valores en el Paso 3: Publicar la API en el 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 Habilitado
    Cuota (déjalo en blanco)
    Permisos de OAuth permitidos (déjalo en blanco)
  4. En laOperaciones sección, haz clic en ADD AN OPERATION para identificar las operaciones que se agregarán a su producto de API.
  5. En Fuente (Source), haz clic en Proxy de API (API Proxy) y selecciona Mock-Target-API en el menú desplegable.
  6. En Operación, ingresa una barra diagonal (/) en el campo Ruta de acceso. Ignora los otros campos.
  7. Haz clic en Guardar para guardar la operación.
  8. Se muestra el cuadro de diálogo Agregar operación (Add Operation). Agrega el proxy de API de Mock-Target-API en el cuadro de diálogo Agregar operación (Add Operation)
  9. Haz clic en Agregar.
  10. Haz clic en Guardar.

Paso 3: Publicar la API en el 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. En la IU de Apigee, navega a la página de las API en tu 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 API Catalog para ver la página de las API.
  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 en la lista de imágenes existentes, en el cuadro de 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.

    Sección de detalles de la API cuando se agrega una API al portal

  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 Import from a URL.
    4. Ingrese helloworld en el campo Spec name.
    5. Copia y pega la siguiente URL en el campo URL y, luego, presiona Enter: 
      https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget3.0.yaml
    6. Haz clic en Seleccionar.

    Sección de documentación de API cuando se agrega una API al portal

  6. Haz clic en Guardar.

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

  1. En la IU de Apigee, haz clic en Portal en vivo para ver los cambios en el portal en vivo (o actualiza el portal en vivo si ya está abierto en otra pestaña).
  2. En el portal en vivo:
    a. Haz clic en API en la barra de navegación superior para ver la API publicada.
    b. Haz clic en la tarjeta Hello World para ver la documentación de referencia de la API.
    c. Prueba tu API.

API de destino ficticio publicada con el panel Prueba esta API