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á una API en el portal siguiendo estos pasos:

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

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

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

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

  1. En la consola de Apigee en Cloud, ve a la página Desarrollo de proxy > Proxies de API.

    Ir a proxies de API

  2. Haz clic en Crear. Se abre el asistente Crear un proxy, que te pide que selecciones el tipo de proxy de API que quieres crear.

  3. Haz clic en el cuadro Plantilla de proxy.

  4. Haga clic en Plantilla de especificación de OpenAPI, proxy inverso (la más habitual).

  5. Abre el siguiente archivo en un navegador y, a continuación, 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, haga clic en Buscar.

  7. Ve al archivo de especificación de OpenAPI que acabas de descargar, selecciónalo y haz clic en Abrir.

  8. Haz clic en Siguiente.

  9. En el paso 2: Detalles del proxy, los campos se rellenan automáticamente con los valores de la especificación OpenAPI. Edita el campo Description (Descripción) de la siguiente manera: API proxy for hello world. (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 quieres implementar.

  14. Haz clic en Aceptar.

  15. Haz clic en Crear.

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

Paso 2: Crea un producto de API

Crea un producto de API que contenga los recursos de API que quieras exponer a tus consumidores de APIs.

Para crear un producto de API, sigue estos pasos:

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

    Ir a productos de API

  2. Haz clic en Crear. Se mostrará la página Detalles del producto. Introduce los detalles del producto de tu producto de API.

    .

    Campo Valor
    Nombre Hola, mundo
    Nombre visible Hola, mundo
    Descripción Ejemplo sencillo de "Hola, mundo"
    Entorno Selecciona el entorno en el que se ha desplegado el proxy de API.
    Acceso Público
    Aprobar automáticamente las solicitudes de acceso Habilitado
    Cuota (dejar en blanco)
    Permisos de OAuth permitidos (dejar en blanco)

  3. En la sección Operaciones, haga clic en Añadir una operación para identificar las operaciones que quiere añadir a su producto de API.

    • En Fuente, selecciona Proxy de API y, a continuación, Mock-Target-API en el menú desplegable.
    • En Operation (Operación), introduce una barra inclinada (/) en el campo Path (Ruta). Ignora los demás campos.

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

  5. Haga clic en Guardar para guardar el producto.

Paso 3: Publica la API en tu portal

Publica la API en tu portal para que tus clientes puedan informarse sobre ella y usarla.

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

  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 Mi primer 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 Publicado (aparece en el catálogo) para publicar la API en tu portal.

  7. En Título visible, introduce Hola, mundo.

  8. En Imagen de display, 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. Para generar automáticamente la documentación de referencia de la API a partir de una instantánea de tu especificación de OpenAPI, sigue estos pasos:

    1. Selecciona Documento de OpenAPI.
    2. Haz clic en Seleccionar.
    3. Haga clic en la pestaña URL.
    4. Escribe helloworld en el campo Nombre de especificación.
    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.

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 interfaz de usuario de Apigee, haz clic en Portal activo para ver los cambios en el portal activo (o actualiza el portal activo si ya está abierto en otra pestaña).
  2. En el portal de emisiones en directo:
    1. En la barra de navegación superior, haga clic en APIs 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!

API de destino simulada publicada con el panel Probar esta API