Operaciones SWAGGER en Open Connectors

Operaciones SWAGGER en Open Connector-1

Contenido

1.    Open Connectors.

2.    Catálogo de Conectores.

3.    Documentos API 3

4.    Operaciones SWAGGER.

5.    Métodos de Petición.

6.    Desarrollo.

1.    Open Connectors

Open Connectors es una de las capacidades que contiene la plataforma de Integration Suite donde le ofrece al usuario una serie de conectores exclusivos y diseñados para unificar la experiencia del desarrollador en cualquier tipo de aplicaciones y servicios expuestos e independientemente del Backend de las aplicaciones (REST, SOAP, SDK, Base de Datos) además su gestión de API con un enfoque centrado en los datos.

SAP Open Connectors crea una capa de API unificada y una implementación basada en los estándares de todos los entornos ya que les garantiza a los desarrolladores, usuarios de integración y sus casos de uso que estén desvinculados de los servicios de Backend de los que dependen.

2.    Catálogo de Conectores

El catálogo de conectores de Open Connector es una lista de tarjetas de conectores exclusivos y disponibles que incluyen una instancia de autentificación dependiendo el conector elegido por el desarrollador que aparece en la parte superior del catálogo, donde cada tarjeta muestra el nombre, el identificador del conector y el número de instancias con las que se pueden acceder a sus servicios de API.

Para trabajar con unos de los conectores disponibles en Open Connectors, se debe acceder a la tarjeta del conector de preferencia y realizar la autenticación para poder visualizar la documentación API que se asocia con la instancia del conector, aunque también se tiene la opción de cargar un conector con un archivo JSON y así poder agregar sus propios recursos.

3.    Documentos API

Los documentos de API se encuentran disponibles en cada uno de los conectores para ayudar a ver qué tipo de solicitudes de API puede acceder el desarrollador. Los documentos API se encuentran disponibles en dos diferentes vistas ya que una de ellas son los documentos de API predeterminados por el conector y la otra vista de los documentos API son los que van relacionados con una instancia asignada y así realizar solicitudes con diferentes operaciones.

4.    Operaciones SWAGGER

Las Operaciones SWAGGER son herramientas equivalentes de una API REST para un servicio web basado en SOAP. Un documento SWAGGER especifica la lista de recursos disponibles y las operaciones a las que se pude interactuar en cada recurso mediante un llamado que se incluye el nombre y el tipo de parámetro que son necesarios u opcionales dependiendo la consulta a realizar.

5.    Métodos de Petición

GET

El método GET solicita la representación de un recurso específico para recuperar datos.

HEAD

El método HEAD pide una respuesta idéntica a la petición GET, pero sin la estructura que contiene la respuesta.

POST

El método POST se utiliza para enviar un recurso a una entidad donde realiza un cambio a su estado para realizar efectos secundarios en el servidor.

PUT

EL método PUT reemplaza las representaciones del recurso de destino con la carga útil de la petición.

DELETE

El método DELETE lo que hace es borrar un recurso de una entidad donde se debe especificar, en la mayoría de los casos se realiza con el ID del recurso.

PATCH

El método PATCH es utilizado para aplicar algunas modificaciones parciales a los recursos de una entidad.

6.    Desarrollo

Realizaremos un ejercicio de implementación y autenticación del conector de Google Drive para poder acceder a sus documentos API y así poder realizar operaciones SWAGGER usando métodos de petición en la plataforma Open Connectors.

Requisitos

Para este ejercicio debemos contar con una cuenta en SAP BTP Cockpit, la suscripción de Integration Suite con la capacidad de Open Connectors activa y una cuenta en Google Drive.

En un navegador accedemos a la siguiente URL https://account.hanatrial.ondemand.com para ingresar a nuestra cuenta de SAP BTP Cockpit.

1
Operaciones SWAGGER en Open Connectors 23

Accedemos a nuestra subcuenta llamada “Logali”.

Una vez en nuestra subcuenta, vamos al menú serviciosà Instancias y suscripciones > Integration Suite.

3 2
Operaciones SWAGGER en Open Connectors 24

También se puede acceder directamente en el apartado de las suscripciones.

En la plataforma de Integration Suite seleccionamos la capacidad de “Open Connectors” para ejecutar la aplicación.

Ingresamos a la capacidad de Open Connectors autenticandonos con nuestro usario y contraseña de la cuenta de SAP BTP Cockpit.

Ya en la plataforma de Open Connectors, navegamos por el menú principal al ítem de Connectors, aquí debemos elegir el conector, para este caso usaremos Google Drive y damos clic en autenticate.

Ingresamos un nombre para la instancia y damos clic en “Create Instance”.

Se debe contar con una cuenta de Google Drive para crear la autenticación.

Una vez ingresados debemos otorgarle los permisos a Open Connectors para poder realizar las diferentes operaciones y acceder a los archivos que contiene la cuenta de Google Drive.

Una vez realizada la autenticación ingresamos y seleccionamos Test in the API docs.

Una vez ingresemos podemos observar los recursos a los que tenemos acceso en la instancia de Google Drive y las diferentes operaciones que se pueden realizar.

Para este ejercicio hemos creado en nuestro Drive una carpeta llamada Open Connectors, que contiene otra carpeta llamada TEST y un archivo llamado test.txt.

Ahora vamos a ejecutar la operación GET del recurso /files para consultar el archivo de nuestra carpeta.Damos clic en el botón “Try it out” para poder editar.

Podemos observar que ya se nos habilitó la edición del método GET.

Tenemos dos atributos obligatorios la Authorization que se carga por defecto y el path que es donde vamos a diligenciar la ruta que contiene nuestro archivo en Google Drive. En nuestro caso como el archivo está en una carpeta la ruta será: /Open Connectors/test.txt,luego ejecutamos el método.

Nota: se debe indicar la extensión del archivo a consultar.

Podemos verificar que el método se ha implementado con éxito al obtener el código 200 en la respuesta. También podemos ver que tenemos la opción de descargar el archivo consultado.

Ahora vamos a implementar el método DELETE para eliminar la carpeta TEST que está dentro de la carpeta Open Connectors en nuestro Google Drive.

Para ello, vamos al recurso folders y dentro de este el método DELETE y luego en el botón Try it out, para habilitar el editor.

Podemos ver que también tenemos dos atributos obligatorios la Authorization que se carga por defecto y el path que es donde vamos a diligenciar la ruta de la carpeta que vamos a eliminar en Google Drive. En nuestro caso como el archivo está en una carpeta la ruta será: /Open Connectors/TEST,luego ejecutamos el método.

Se puede ver que se obtiene una respuesta de código 200 que se refiere a operación exitosa.

Verificamos en Google Drive que la carpeta TEST efectivamente haya sido eliminada.

Por último, vamos a usar el método POST, para esta operación vamos a crear una carpeta llamada Test1, dentro de nuestra carpeta de Open Connectors en nuestro Google Drive.

En los recursos de folders vamos al método POST y damos en el botón Try it out para editar.

En este caso podemos ver que los atributos obligatorios son la Authorization que se carga por defecto y el body que contiene por defecto un modelo de la información necesaria para crear la carpeta.

Modificaremos las variables name que va a contener el nombre de la carpeta y el path que es donde indicamos la ruta donde se creará, incluyendo el nombre de la misma.

name: “Test1”

path: “/Open Connectors/Test1”

Además, vamos a modificar las variables “CreatedDate” “ModifiedDate” ya que al momento de enviar los datos no toma las variables como un arreglo si no como un objeto.

Estructura Original

createdDate: “2022-01-14T14:59:45.645Z”

modifiedDate: “2022-01-14T14:59:45.645Z”

Estructura Modificada

createdDate: “2022-01-14T14:59:45Z”

modifiedDate: “2022-01-14T14:59:45Z”

Luego ejecutamos el método.

19 1
Operaciones SWAGGER en Open Connectors 25

Se puede ver que se obtiene una respuesta de código 200 que se refiere a operación exitosa.

Verificamos que efectivamente se haya creado la carpeta en Google Drive.

3 comentarios de “Operaciones SWAGGER en Open Connectors

Deja una respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *

Suscríbete al blog
Recibe las últimas actualizaciones y contenidos exclusivos directamente en tú correo electrónico.
Inscribime
close-link