@syss/arch-nodejs-runtime v1.0.0

README

Librería que contiene las utilidades con el formato de logs de las lambdas nodejs que se ejecutan y utilidades para el parseo de los fichero Swagger.

Uso de la librería

Para el uso de la librería de aspects es necesario tener acceso al repositorio en el que esta contenida y, posteriormente, seguir los siguientes pasos:

• Añadir la dependencia de la librería en el proyecto que se va a importar. Para ello, añadir la siguiente línea al archivo package.json del proyecto: arch-nodejs-runtime@version

• Descargar la dependencia de la librería: npm install arch-nodejs-runtime@version

Una vez incluida y descargada la dependencia es posible el uso de la librería.

Uso de Open Api Helper

Esta librería ofrece la utilidad parsear un swagger y extraer en un array los scopes. Para ello, se debe importar la clase OpenApiHelper la cual debe recibir 2 parametros obligatorios y uno opcional:

• Ubicacion del swagger que se desea parsear.
• Scope que se desea buscar dentro del swagger.
• Custom parametro opcional para introducir una propiedad custom a buscar diferente de 'uri' o 'authorizerUri'.

Un ejemplo para buscar una uri con el scope seria el siguiente:

let fileName = 'test/src/asistencia_original.yaml';
const openApiHelper = new OpenApiHelper();
const result = openApiHelper.searchTags(fileName, 'cognito-integration-authorizer');

Un ejemplo para buscar una una propiedad custom 'identitySource' con el scope seria el siguiente:

let fileName2 = 'test/src/api_client_sample_v1.0.6_Public.yaml';
const openApiHelper = new OpenApiHelper();
const result = openApiHelper.searchTags(fileName2, 'x-amazon-apigateway-authorizer', 'identitySource');

De esta manera, la librería buscara en el swagger la propiedad correspondiente al scope y devolvera un array con todos los resultados encontrados.