Generación de APIs en Oracle API Platform

En la actualidad, el uso de APIs está muy extendido y en nuestro día a día es muy necesario estar familiarizado con ellas. Existen numerosos productos o herramientas que nos permiten gestionar y mantener nuestras APIs. En este post vamos a centrarnos en una de las soluciones que nos ofrece Oracle: Oracle API Platform.

 

Oracle API Platform es una herramienta que nos facilitará la construcción y exposición de nuestros servicios a través de APIs. Dispone de una gran cantidad de políticas que nos permiten controlar el uso que se realiza de dichas APIs. Encontraremos políticas de seguridad, políticas para el control de tráfico, políticas para el enrutamiento de las peticiones y muchas más.

 

Oracle Api Platform dispone de dos consolas para la gestión de las APIs.

  • Management Console: nos permitirá definir, publicar, exponer y controlar el uso de las APIs. Es donde se lleva a cabo la parte de creación de estas APIs y donde se especifica que ha de hacer cada una de ellas.
  • Developer Portal: nos permite compartir nuestras APIs, así como sus especificaciones con personal de nuestra compañía para la reutilización de las mismas.

 

Además, tenemos que tener en cuenta que todas estas APIs serán desplegadas y ejecutadas sobre Gateways, los cuales deberán darse de alta en el portal de administración (Management Console).

 

La siguiente imagen muestra todas estas piezas y cómo interaccionan entre sí.

 

 

 

Cómo generar una API en Oracle API Platform

 

Oracle API Platform nos permite realizar esta tarea de una forma sencillísima y con muy poco esfuerzo, tal como vamos a ver a continuación.

Lo primero que debemos hacer es abrir la consola del portal de administración de Oracle API Platform introduciendo nuestras credenciales. Esto nos llevará a la página principal de dicho portal.

 

 

 

En la sección API, que es la que por defecto aparece al conectarnos, pulsamos sobre el botón “Create”. Esto abrirá una nueva ventana donde indicaremos Nombre y Versión de la API a crear.

 

 

 

Una vez que pulsemos en el botón “Create” se nos generará esta API en la sección de APIs:

 

 

El siguiente paso es configurar esta API, haciendo doble clic sobre ella.

Se abrirá la página de especificaciones de la API, y pulsaremos sobre el botón : que nos llevará a la sección de configuración de la API.

 

 

 

Por defecto veremos dos configuraciones, que son obligatorias para toda API y que debemos indicar:

  • API Request: En ella indicaremos la URI relativa de la API (bajo la que se va a exponer), así como los protocolos permitidos

 

 

  • Service Request: En ella indicaremos la URI del servicio REST al que va a atacar la API, así como los criterios de seguridad que ese servicio requiera.

 

 

Una vez configurados estos puntos, guardaremos la configuración pulsando en el botón “Save”:

 

 

Con esto ya tenemos nuestra API configurada; pero, para poder probarla, antes debemos desplegarla en un Gateway (que ha de estar dado de alta en el sistema).

Para ello pulsamos en la opción de despliegue de API:

 

 

Y pulsamos en “Deploy API”. Esto nos abrirá una ventana emergente donde seleccionaremos el Gateway donde desplegarlo y pulsamos en “Deploy”.

 

 

 

Hecho esto veremos que nuestro despliegue se queda “En espera” hasta que sea desplegado por el servidor.

 

 

 

Pasado un rato, veremos que el estado cambia a Desplegado y podemos probarlo.

 

 

 

Para probarlo, abrimos en un explorador dicho servicio. La url del mismo es: http://<IP_Gateway>/avanttic/api_prueba_blog.

 

El resultado que obtendremos es el siguiente:

 

 

 

Inclusión de política de seguridad en el servicio

 

Resulta muy sencillo incluir seguridad básica en las APIs gracias a las políticas que Oracle API Platform nos facilita por defecto. Para ello, abriremos la API que habíamos generado anteriormente:

 

En ella asignaremos una política de seguridad básica. Esta opción se encuentra en el menú de implantación de la API

 

 

 

Abrimos las políticas de seguridad disponibles:

 

 

 

Y seleccionamos “Apply” en la política de Autenticación básica. Se abrirá una ventana emergente con dos pasos; en el primero indicaremos el nombre de la política y pulsaremos en la flecha.

 

 

En el segundo paso marcaremos All users, lo que indicará que todos los usuarios dados de alta en el Gateway, donde se despliegue la API, pueden ejecutarla. A continuación pulsaremos en “Apply”.

 

 

Ahora podemos ver la política aplicada en la definición de la API.

 

 

Lo siguiente será Guardar los cambios y redesplegar la API en nuestro Gateway antes de proceder a probarlo.

 

Una vez desplegado el cambio, procederemos a probarlo. Como en este caso se requiere la información de una política de seguridad, nos vamos a apoyar en un cliente de pruebas como puede ser Postman.

Abrimos Postman y configuramos una petición sin indicar usuario y contraseña. Ejecutamos y veremos que no estamos autorizados (cod 401) porque no hemos indicado usuario y contraseña correctas.

 

 

Si ahora indicamos un usuario y contraseña correctos obtendremos la siguiente respuesta:

 

 

Como hemos podido ver, Oracle API Platform nos facilita la gestión de nuestras APIs y nos permite una exposición de las mismas con un esfuerzo mínimo. Además, hemos podido observar que securizar estas APIs es una tarea muy sencilla gracias a las políticas que Oracle API Platform nos facilita.

 

Obviamente este producto nos brinda más posibilidades en la gestión de las APIs y nos permite analizar consumos y errores de las mismas, pero eso lo veremos en futuros posts.

Twitter
LinkedIn
Evolución, innovación y transformación
37 Service Expertise avalados por Oracle 
Nuestra propuesta de valor
Posts 100% Oracle
Sigue nuestro día a día