https://github.com/andresweitzel/microservice_mercadolibre_products_aws
Microservicio para la gestión de productos, ejemplificando parte de la arquitectura de desarrollo de ML implementada con Typescript, Amazon S3, Systems Manager Parameter Store, Api-Gateway, Serverless-Framework, Lambda, Sequelize, Mysql, Amazon RDS, entre otros.
https://github.com/andresweitzel/microservice_mercadolibre_products_aws
amazon-s3 amazon-web-services aws-sdk-v3 git mysql sequelize-orm serverless serverless-framework serverless-offline typescript
Last synced: 27 days ago
JSON representation
Microservicio para la gestión de productos, ejemplificando parte de la arquitectura de desarrollo de ML implementada con Typescript, Amazon S3, Systems Manager Parameter Store, Api-Gateway, Serverless-Framework, Lambda, Sequelize, Mysql, Amazon RDS, entre otros.
- Host: GitHub
- URL: https://github.com/andresweitzel/microservice_mercadolibre_products_aws
- Owner: andresWeitzel
- License: gpl-3.0
- Created: 2023-04-23T19:47:26.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-10-15T01:34:59.000Z (over 1 year ago)
- Last Synced: 2025-02-01T12:46:19.537Z (3 months ago)
- Topics: amazon-s3, amazon-web-services, aws-sdk-v3, git, mysql, sequelize-orm, serverless, serverless-framework, serverless-offline, typescript
- Language: TypeScript
- Homepage:
- Size: 413 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Microservice\_Mercadolibre\_Products\_AWS
Microservicio para la gestión de productos, ejemplificando parte de la arquitectura de desarrollo de ML implementada con Typescript, Amazon S3, Systems Manager Parameter Store, Api-Gateway, Serverless-Framework, Lambda, Sequelize, Mysql, Amazon RDS, entre otros.
Los servicios de aws se prueban en local. El código del proyecto y la documentación de este (menos doc técnica), ha sido desarrollado/a en inglés.
* [Repositorio base de datos](https://github.com/andresWeitzel/Microdb_MercadoLibre_Productos_Mysql)
* [Api Doc ML Productos](https://developers.mercadolibre.com.ar/es_ar/publica-productos)
* [Playlist prueba de funcionalidad](https://www.youtube.com/playlist?list=PLCl11UFjHurAs3C8syrdYMZfQ0nUokcjz)
## Índice 📜
Ver
### Sección 1) Descripción, configuración y tecnologías.
* [1.0) Descripción del Proyecto.](#10-descripción-)
* [1.1) Ejecución del Proyecto.](#11-ejecución-del-proyecto-)
* [1.2) Configuración del proyecto desde cero](#12-configuración-del-proyecto-desde-cero-)
* [1.3) Tecnologías.](#13-tecnologías-)
### Sección 2) Endpoints y Ejemplos
* [2.0) EndPoints y recursos.](#20-endpoints-y-recursos-)
* [2.1) Ejemplos.](#21-ejemplos-)
### Sección 3) Prueba de funcionalidad y Referencias
* [3.0) Prueba de funcionalidad.](#30-prueba-de-funcionalidad-)
* [3.1) Referencias.](#31-referencias-)
## Sección 1) Descripción, configuración y tecnologías.
### 1.0) Descripción [🔝](#índice-)
Ver
### 1.0.0) Descripción General
### 1.0.1) Descripción Arquitectura y Funcionamiento
### 1.1) Ejecución del Proyecto [🔝](#índice-)
Ver
* Una vez creado un entorno de trabajo a través de algún ide, clonamos el proyecto
```git
git clone https://github.com/andresWeitzel/Microservice_Mercadolibre_Users_AWS
```
* Nos posicionamos sobre el proyecto
```git
cd 'projectName'
```
* Instalamos la última versión LTS de [Nodejs(v18)](https://nodejs.org/en/download)
* Instalamos Serverless Framework de forma global si es que aún no lo hemos realizado
```git
npm install -g serverless
```
* Verificamos la versión de Serverless instalada
```git
sls -v
```
* Instalamos todos los paquetes necesarios
```git
npm i
```
* Las variables ssm utilizadas en el proyecto se mantienen para simplificar el proceso de configuración del mismo. Es recomendado agregar el archivo correspondiente (serverless\_ssm.yml) al .gitignore.
* El script start configurado en el package.json del proyecto, es el encargado de levantar
* El plugin de serverless-offline
* El plugin remark-lint para archivos .md (se aplica solo el --output para check and autoformat sin terminar el proceso y poder ejecutar el script de serverless)
```json
"scripts": {
"check": "remark . --quiet --frail",
"format": "remark . --quiet --frail --output",
"format-md": "remark . --output",
"serverless-offline": "sls offline start",
"start": "npm run format-md && npm run serverless-offline"
},
```
* Ejecutamos la app desde terminal.
```git
npm start
```
* Si se presenta algún mensaje indicando qué el puerto 4000 ya está en uso, podemos terminar todos los procesos dependientes y volver a ejecutar la app
```git
npx kill-port 4000
npm start
```
### 1.2) Configuración del proyecto desde cero [🔝](#índice-)
Ver
* Creamos un entorno de trabajo a través de algún ide, luego de crear una carpeta nos posicionamos sobre la misma
```git
cd 'projectName'
```
* Instalamos la última versión LTS de [Nodejs(v18)](https://nodejs.org/en/download)
* Instalamos Serverless Framework de forma global si es que aún no lo hemos realizado
```git
npm install -g serverless
```
* Verificamos la versión de Serverless instalada
```git
sls -v
```
* Inicializamos un template ts de serverles
```git
serverless create --template aws-nodejs-typescript
```
* Comprobamos la versión de typescript
```git
tsc -v
```
* Instalamos los paquetes necesarios
```git
npm i
```
* Para este caso vamos a utilizar la manera tradicional de configuración para los archivos del proyecto. (serverless.yml, src/helpers, src/resources, src/controllers, src/services , etc). Por ende se modifican los archivos de la plantilla base.
* Instalamos serverless offline
```git
npm i serverless-offline --save-dev
```
* Instalamos serverless ssm
```git
npm i serverless-offline-ssm --save-dev
```
* Instalamos S3 local
```git
npm install serverless-s3-local --save-dev
```
* Instalamos el Cliente s3
```git
npm install @aws-sdk/client-s3
```
* Agregamos los plugins de serverless al .yml
```yml
plugins:
- serverless-esbuild
- serverless-s3-local
- serverless-offline-ssm
- serverless-offline
```
* Instalamos sequelize
```git
npm install sequelize --save
```
* Instalamos los plugins necesarios para el [uso de sequelize con ts junto a nodejs](https://sequelize.org/docs/v6/other-topics/typescript/) según la doc oficial. [Doc de los siguientes plugins](https://www.npmjs.com/package/sequelize-typescript)
```git
npm install --save-dev @types/node @types/validator
npm install sequelize reflect-metadata sequelize-typescript
```
* Luego agregamos la configuración en `tsconfig.json`, dentro de `compilerOptions`. Si existe un target eliminar uno.
```git
"target": "es6", // or a more recent ecmascript version
"experimentalDecorators": true,
"emitDecoratorMetadata": true
```
* Instalamos `mysql2` para usar el sgdb mysql
```git
npm i mysql2 --save
```
* Usando ts se ha presentado problemas al intentar importar un módulo de conexión de postgres por parte de nodejs, más allá que nunca se usa. Instalamos el módulo de forma manual
```git
npm i pg-hstore --save
```
* Configuraremos un formato estándar de archivos markdown para el proyecto a través de [remark-lint](https://github.com/remarkjs/remark-lint#example-check-markdown-on-the-api)
```git
npm install remark-cli remark-preset-lint-consistent remark-preset-lint-recommended remark-lint-list-item-indent --save-dev
npm install remark-lint-emphasis-marker remark-lint-strong-marker --save-dev
npm install remark-lint-table-cell-padding --save-dev
```
* Luego agregamos la configuración para los scripts desde el package.json
```json
"scripts": {
"check": "remark . --quiet --frail",
"format": "remark . --quiet --frail --output",
},
```
* En mi caso, quiero que se aplique un autoformato por cada ejecución, aplico concurrently, quedando
```json
"scripts": {
"check": "remark . --quiet --frail",
"format": "remark . --quiet --frail --output",
"format-md": "remark . --output",
"serverless-offline": "sls offline start",
"start": "npm run format-md && npm run serverless-offline"
},
```
* Luego agregamos los remark configs debajo de todo en el package.json
```json
"remarkConfig": {
"settings": {
"emphasis": "*",
"strong": "*"
},
"plugins": [
"remark-preset-lint-consistent",
"remark-preset-lint-recommended",
"remark-lint-table-cell-padding",
[
"remark-lint-list-item-indent",
"tab-size"
],
[
"remark-lint-emphasis-marker",
"*"
],
[
"remark-lint-strong-marker",
"*"
]
]
}
```
* Para más información al respecto, visitar la [página oficial](https://github.com/remarkjs/remark-lint#example-check-markdown-on-the-api)
* Las variables ssm utilizadas en el proyecto se mantienen para simplificar el proceso de configuración del mismo. Es recomendado agregar el archivo correspondiente (serverless\_ssm.yml) al .gitignore.
* El siguiente script (start), configurado en el package.json del proyecto, es el encargado de ejecutar
* El plugin de serverless-offline
* El plugin remark-lint para archivos .md
```json
"scripts": {
"check": "remark . --quiet --frail",
"format": "remark . --quiet --frail --output",
"format-md": "remark . --output",
"serverless-offline": "sls offline start",
"start": "npm run format-md && npm run serverless-offline"
},
```
* Ejecutamos la app desde terminal.
```git
npm start
```
* Si se presenta algún mensaje indicando qué el puerto 4000 ya está en uso, podemos terminar todos los procesos dependientes y volver a ejecutar la app
```git
npx kill-port 4000
npm start
```
### 1.3) Tecnologías [🔝](#índice-)
Ver
| **Tecnologías** | **Versión** | **Finalidad** |\
| ------------- | ------------- | ------------- |
| [SDK](https://www.serverless.com/framework/docs/guides/sdk/) | 4.3.2 | Inyección Automática de Módulos para Lambdas |
| [Serverless Framework Core v3](https://www.serverless.com//blog/serverless-framework-v3-is-live) | 3.23.0 | Core Servicios AWS |
| [Systems Manager Parameter Store (SSM)](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html) | 3.0 | Manejo de Variables de Entorno |
| [Amazon Api Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/welcome.html) | 2.0 | Gestor, Autenticación, Control y Procesamiento de la Api |
| [Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingBucket.html) | 3.0 | Contenedor de Objetos |
| [NodeJS](https://nodejs.org/en/) | 14.18.1 | Librería JS |
| [Typescript](https://www.typescriptlang.org/) | 3.8.3 | Lenguaje con alto tipado basado en JS |
| [Sequelize](https://sequelize.org/) | ^6.11.0 | ORM |
| [Mysql](https://www.mysql.com/) | 10.1 | SGDB |
| [XAMPP](https://www.apachefriends.org/es/index.html) | 3.2.2 | Paquete de servidores |
| [VSC](https://code.visualstudio.com/docs) | 1.72.2 | IDE |
| [Postman](https://www.postman.com/downloads/) | 10.11 | Cliente Http |
| [CMD](https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/cmd) | 10 | Símbolo del Sistema para linea de comandos |
| [Git](https://git-scm.com/downloads) | 2.29.1 | Control de Versiones |
| **Plugin** |
| ------------- |
| [Serverless Plugin](https://www.serverless.com/plugins/) |
| [serverless-offline](https://www.npmjs.com/package/serverless-offline) |
| [serverless-offline-ssm](https://www.npmjs.com/package/serverless-offline-ssm) |
| [serverless-s3-local](https://www.serverless.com/plugins/serverless-s3-local) | complemento sin servidor para ejecutar clones de S3 en local
| **Extensión** |\
| ------------- |
| Prettier - Code formatter |
| YAML - Autoformatter .yml |
| Typescript Toolbox - generate setters, getters, constrc, etc |
## Sección 2) Endpoints y Ejemplos.
### 2.0) Endpoints y recursos [🔝](#índice-)
Ver
### 2.1) Ejemplos [🔝](#índice-)
Ver
## Sección 3) Prueba de funcionalidad y Referencias.
### 3.0) Prueba de funcionalidad [🔝](#índice-)
Ver
### 3.1) Referencias [🔝](#índice-)
Ver
#### Configuración
* [Configuración de Typescript y Serverless](https://blog.logrocket.com/building-serverless-app-typescript/)
#### Ejemplos proyectos typescript/serverless
* [Serverless Framework AWS TypeScript Example](https://github.com/serverless/examples/tree/v3/aws-node-typescript)
* [Apollo Lambda GraphQL API Example](https://github.com/serverless/examples/tree/v3/aws-node-typescript-apollo-lambda)
## Ejemplos proyectos typescript/serverless/sequelize
* [Proyecto sequelize](https://javascript.plainenglish.io/how-to-use-sequelize-v6-orm-lambda-with-typescript-2dfc56dee6a1)
#### Herramientas
* [Herramienta de Diseño AWS app.diagrams.net](https://app.diagrams.net/?splash=0\&libs=aws4)
#### Sequelize
* [Modelos y Operadores](https://sequelize.org/docs/v6/core-concepts/model-querying-basics/)
#### Api Gateway
* [Buenas Prácticas Api-Gateway](https://docs.aws.amazon.com/whitepapers/latest/best-practices-api-gateway-private-apis-integration/rest-api.html)
* [Creación de Api-keys personalizadas](https://towardsaws.com/protect-your-apis-by-creating-api-keys-using-serverless-framework-fe662ad37447)
#### Configuración buckets
* [s3-example](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/s3-example-configuring-buckets.html)
* [s3-examples oficial](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/s3-node-examples.html)
#### Librerías
* [Validación de campos](https://www.npmjs.com/package/node-input-validator)
* [Validación de propiedades de clases](https://www.npmjs.com/package/class-validator)
* [Configuración de prettier con ESLint](https://khalilstemmler.com/blogs/tooling/prettier/)
* [Comprobación y configuración de formato markdown](https://github.com/remarkjs/remark-lint#example-check-markdown-on-the-api)