Categorygithub.com/nmarsollier/ordersgo
modulepackage
0.0.0-20241219123354-b6f0e466f69e
Repository: https://github.com/nmarsollier/ordersgo.git
Documentation: pkg.go.dev

# README

Orders Service en GO

Este Microservicio de Ordenes del proyecto

Microservicios

Documentación de API

La documentación de las api también se pueden consultar desde el home del microservicio que una vez levantado el servidor se puede navegar en localhost:3004

El servidor GraphQL puede navegar en localhost:4004

Directorios

  • events: Eventos CQRS
  • projections: Proyecciones de negocio de los eventos
  • security: Validaciones de usuario contra el MS de Auth
  • services: Servicios de dominio para el negocio.
  • graph: Servidor y Controllers GraphQL federation server
  • rabbit: Servidor y Controllers RabbitMQ
  • rest: Servidor y Controllers Rest
  • tools: Herramientas varias

Requisitos

Go 1.21 golang.org

Configuración inicial

establecer variables de entorno (consultar documentación de la version instalada)

Para descargar el proyecto correctamente hay que ejecutar :

git clone https://github.com/nmarsollier/ordersgo $GOPATH/src/github.com/nmarsollier/ordersgo

Una vez descargado, tendremos el codigo fuente del proyecto en la carpeta

cd $GOPATH/src/github.com/nmarsollier/ordersgo

Dependencias

Auth

Las ordenes sólo puede usarse por usuario autenticados, ver la arquitectura de microservicios de ecommerce.

Catálogo

Las ordenes tienen una fuerte dependencia del catalogo:

  • Se validan los artículos contra el catalogo.
  • Se descuentan los artículos necesarios.
  • Se puede devolver articulos si la orden se cancela.

Ver la arquitectura de microservicios de ecommerce.

Instalar Librerías requeridas

git config core.hooksPath .githooks
go install github.com/swaggo/gin-swagger/swaggerFiles
go install github.com/swaggo/gin-swagger
go install github.com/swaggo/swag/cmd/swag
go install github.com/golang/mock/[email protected]
go install github.com/99designs/[email protected]

Build y ejecución

go install
ordersgo

MongoDB

La base de datos se almacena en MongoDb.

Seguir las guías de instalación de mongo desde el sitio oficial mongodb.com

No se requiere ninguna configuración adicional, solo levantarlo luego de instalarlo.

RabbitMQ

Este microservicio notifica los logouts de usuarios con Rabbit.

Seguir los pasos de instalación en la pagina oficial rabbitmq.com

No se requiere ninguna configuración adicional, solo levantarlo luego de instalarlo.

Swagger

Usamos swaggo

Requisitos

go install github.com/swaggo/swag/cmd/swag@latest

La documentacion la generamos con el comando

swag init

Para generar el archivo README-API.md

Requisito

sudo npm install -g swagger-markdown

y ejecutamos

npx swagger-markdown -i ./docs/swagger.yaml -o README-API.md

Configuración del servidor

Este servidor usa las siguientes variables de entorno para configuración :

RABBIT_URL : Url de rabbit (default amqp://localhost) MONGO_URL : Url de mongo (default mongodb://localhost:27017) PORT : Puerto (default 3004) GQL_PORT : Puerto GraphQL (default 4004)

Docker

Estos comandos son para dockerizar el microservicio desde el codigo descargado localmente.

Build

docker build -t dev-order-go .

El contenedor

Mac | Windows

docker run -it --name dev-order-go -p 3004:3004 -p 3004:3004 -v $PWD:/go/src/github.com/nmarsollier/ordersgo dev-order-go

Linux

docker run -it --add-host host.docker.internal:172.17.0.1 --name dev-order-go -p 3004:3004 -p 4004:4004 -v $PWD:/go/src/github.com/nmarsollier/ordersgo dev-order-go

# Packages

Package docs Code generated by swaggo/swag.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author