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. Crea 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:

IU de la consola de Cloud

1. En la consola de Apigee en Cloud, ve a la página Proxy Development > API proxies.

   Ir a los proxies de API

2. Haz clic en Crear. Se abrirá el asistente Crear un proxy y te solicitará que selecciones el tipo de proxy de API que deseas crear.

3. Haz clic en el cuadro Proxy template.

4. Haz clic en Plantilla de especificación de OpenAPI, proxy inverso (más común).

5. Abre el siguiente archivo en un navegador y, luego, guárdalo:

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

6. En Paso 1: Especificaciones de OpenAPI, haz clic en Explorar.

7. Navega a un archivo de especificaciones de OpenAPI que acabas de descargar, selecciónalo y, luego, haz clic en Abrir.

8. Haz clic en Siguiente.

9. En Paso 2: Detalles del proxy, los campos se propagan previamente con los valores de la especificación de OpenAPI. Edita el campo Descripción de la siguiente manera: proxy de API para Hello World.

10. Haz clic en Siguiente.

11. En Paso 3: Flujos, selecciona todas las operaciones.

12. Haz clic en Siguiente.

13. En Paso 4: Implementar, selecciona el entorno en el que deseas realizar la implementación.

14. Haz clic en Aceptar.

15. Haz clic en Crear.

Nota: Es posible que Apigee tarde unos minutos en implementar el proxy nuevo.

Cuando el proxy está implementado, la columna Estado en la sección Implementaciones muestra un ícono verde para indicar que se implementó la revisión del proxy de API. Puedes mantener el puntero sobre el ícono de estado para ver más información sobre la implementación.

IU clásica

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

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

   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. Se abrirá el asistente de creación de proxy y se propagará la página Detalles del proxy con los valores de la especificación de OpenAPI.

   

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

   

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

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, sigue estos pasos:

1. En Apigee en la consola de Cloud, ve a la página Distribución > Productos de API.

   Ir a Productos de API

2. Haz clic en Crear. Se muestra la página Detalles del producto. 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)

3. En la sección Operaciones, haz clic en Agregar una operación para identificar las operaciones que se agregarán a tu producto de API.

   • En Fuente, selecciona Proxy de API y, luego, Mock-Target-API en el menú desplegable.
   • En Operación, ingresa una barra diagonal (/) en el campo Ruta de acceso. Ignora los otros campos.

4. Haz clic en Guardar para guardar la operación.

5. Haz clic en Guardar para guardar el producto.

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 tu portal, sigue estos pasos:

IU de la consola de Cloud

1. En la consola de Apigee en Cloud, ve a la página Distribución > Portales.

   Ir a Portales

2. Haz clic en la fila My first portal para abrir el portal.

3. Haz clic en la pestaña APIs.

4. Haz clic en + API.

5. En Producto de API, selecciona Hello World.

6. Selecciona Publicada (enumerada en el catálogo) (Publish [listed in the catalog]) para publicar la API en tu portal.

7. En Título visible, ingresa Hello World.

8. En Imagen visible, haz clic en Seleccionar.

9. Haz clic en Recursos.

10. Haz clic en Vista previa para home-background.jpg.

11. Haz clic en Seleccionar.

12. En Documentación de la API (API documentation), para generar automáticamente la documentación de referencia de la API a partir de una instantánea de tu especificación de OpenAPI, haz lo siguiente:

    1. Selecciona Documento de OpenAPI.
    2. Haz clic en Seleccionar.
    3. Haz clic en la pestaña URL.
    4. Escribe helloworld en el campo Spec name.
    5. Copia y pega la siguiente URL en el campo URL:

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

    6. Haz clic en Seleccionar.

13. Haz clic en Guardar.

IU clásica

1. En la IU de Apigee, navega a la página de las APIs 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, 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, 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.

   

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.

   

6. Haz clic en Guardar.

Paso 4: Consulta la documentación de referencia de la API

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

1. En la IU de Apigee, haz clic en Live Portal 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, haz lo siguiente:
   1. Haz clic en API en la barra de navegación superior para ver la API publicada.
   2. Haz clic en la tarjeta Hello World para ver la documentación de referencia de la API.
   3. Prueba tu API.

¡Felicitaciones! Completaste el instructivo correctamente. ¿Desea obtener más información? Ve a la documentación del portal de Apigee.