Swagger o como documentar la transformación digital

by InnVaria
in SAP
on 15 Marzo 2017
Visto: 783

A la hora de transformar digitalmente nuestros sistemas y adaptarnos al diseño de nuestro software como un servicio, los consultores técnicos de SAP nos enfrentamos a un mundo muy diferente a la forma habitual de trabajar.  Muchos de los retos vienen de enfrentarnos a tecnologías desconocidas o poco usadas en el desarrollo ABAP pero ampliamente adoptadas como un estándar de industria.

Uno de ellos es la documentación efectiva de nuestros APIs RESTful  y aunque SAP acertó de pleno al decidir adoptar el estándar OData (http://www.odata.org/) en los servicios SAP Gateway, donde el servicio se describe completamente en su sección de metadatos, todavía podemos ir un paso más allá para documentar nuestras APIs.

Swagger  (http://swagger.io/) es la herramienta más adoptada para la documentación, diseño y desarrollo de APIs. Es además un proyecto de código abierto y desde la versión 2.0 se adhiere a la iniciativa OpenAPI (http://www.openapis.org) que promueve la creación de un formato independiente de la plataforma para describir APIS.

Todo esto no han pasado desapercibido para SAP que, siguiendo su nueva filosofía de usar lo que ya funciona, ha basado parte de su SAP Hana Cloud Platform API Management en Swagger, permitiéndonos transformar nuestros metadatos al formato Open API.v

Veamos un ejemplo; en InnVaria hemos activado el servicio Gateway para Interlocutores Comerciales de SAP CRM. Este servicio, entre otras muchas cosas modela las operaciones para trabajar con empleados y por tanto define una entidad empleado. Si vamos al servicio, podemos ver como en los metadatos tenemos una definición de los campos, con sus etiquetas, sus tipos e incluso las relaciones:

 Definicion de campos

Esto nos da una buena información de cómo es esta entidad y ciertamente para un técnico es un buen punto de comienzo para descubrir la API.
Sin embargo, otras cosas se nos quedan fuera: como se hace una lectura, cómo se hace una creación, qué parámetros podemos usar para filtrar nuestras búsquedas. Afortunadamente, Swagger junto con el SAP API Management nos ayuda a cubrir este hueco a partir de la información que ya tenemos. Podemos ver cada una de las operaciones en una web donde podemos interactuar con ellas e incluso probarlas

 Además, para cada una de las operaciones podemos ver los parámetros que acepta y una visión mucho más amigable

En definitiva, en un mundo donde la tendencia es la interconexión de sistemas mediantes APIS REST, gracias a herramientas como Swagger y SAP API Management podemos documentar nuestros repositorios de una forma sencilla, amigable y productiva.

Nuestros clientes confían en nosotros para sus proyectos de transformación digital, donde la interconexión entre diferentes plataformas de negocio se vuelve vital. Con el objetivo de tratar de llevar nuestro delivery lo más próximo a la excelencia, es una obligación poder entregar una definición tan exhaustiva y útil como la que nos ofrece esta herramienta. Si tiene dudas o si por el contrario le gustaría poder profundizar en esta herramienta y en nuestra metodología desarrollada adhoc para lo que nosotros llamamos la “documentación de la transformación digital”, por favor no dude en ponerse en contacto con nosotros y estaremos encantados de poder ayudar a que su compañía sea excelente también en este sentido.

Esta dirección de correo electrónico está siendo protegida contra los robots de spam. Necesita tener JavaScript habilitado para poder verlo.
Technical Director

 

Deja tus comentarios

0
terms and condition.

0 Comentarios