imagego

command module
v0.0.0-...-39a8028 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 23, 2023 License: GPL-3.0 Imports: 2 Imported by: 0

README

Si queres sabes mas sobre mi:

Nestor Marsollier

Image Service en GO

Image Service en GO reemplaza la version realizada en Node del proyecto ecommerce.

Si bien esta desarrollado con fines académicos, si se refinan los detalles puede utilizarse en producción.

Este microservicio recibe y almacena imágenes en formato base64 en una base de datos redis.

El cliente puede solicitar las imágenes en distintos tamaños, cada tamaño se ajusta y se guarda en la base de datos para una mejor velocidad de acceso en futuras llamadas.

Las imágenes pueden recuperarse en formato base64 o bien en formato jpeg.

Documentación de API

Dependencias

Auth

Las imágenes solo pueden subirse y descargarse por usuarios autenticados, ver la arquitectura de microservicios de ecommerce.

Requisitos

Go 1.14 golang.org

Configuración inicial

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

export GO111MODULE=on
export GOFLAGS=-mod=vendor

Para descargar el proyecto correctamente hay que ejecutar :

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

Una vez descargado, tendremos el código fuente del proyecto en la carpeta

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

Instalar Librerías requeridas

go mod download
go mod vendor

Build y ejecución

go install
imagego

Redis

Las imágenes se almacenan en una instancia de Redis. Seguir los pasos de instalación desde la pagina oficial redis.io

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

RabbitMQ

Solo usuarios autorizados pueden subir y descargar imágenes. El microservicio Auth es el que identifica usuarios. Auth notifica con un broadcast los logouts en la aplicación para que se vacíen los caches locales de usuario.

Seguir los pasos de instalación en la pagina oficial de RabbitMQ

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

Apidoc

Apidoc es una herramienta que genera documentación de apis para proyectos node (ver Apidoc).

El microservicio muestra la documentación como archivos estáticos si se abre en un browser la raíz del servidor localhost:3001

Ademas se genera la documentación en formato markdown.

Para que funcione correctamente hay que instalarla globalmente con

npm install apidoc -g
npm install -g apidoc-markdown2

La documentación necesita ser generada manualmente ejecutando la siguiente linea en la carpeta imagego :

apidoc -o www
apidoc-markdown2 -p www -o README-API.md

Esto nos genera una carpeta con la documentación, esta carpeta debe estar presente desde donde se ejecute imagego, imagego busca ./www para localizarlo, aunque se puede configurar desde el archivo de properties.

Configuración del servidor

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

RABBIT_URL : Url de rabbit (default amqp://localhost) REDIS_URL : Url de redis (default localhost:6379) PORT : Puerto (default 3000) WWW_PATH : Path donde se ubica la documentación apidoc (default www) AUTH_SERVICE_URL : Secret para password (default http://localhost:3000)

Docker

Build

docker build -t dev-image-go .

El contenedor

# Mac | Windows
docker run -it --name dev-image-go -p 3001:3001 -p 40001:40001 -v $PWD:/go/src/github.com/nmarsollier/imagego dev-image-go

# Linux
docker run -it --add-host host.docker.internal:172.17.0.1 --name dev-image-go -p 3001:3001 -p 40001:40001 -v $PWD:/go/src/github.com/nmarsollier/imagego dev-image-go

Debug en Docker

Existe un archivo Docker.debug, hay que armar la imagen usando ese archivo.

docker build -t debug-image-go -f Dockerfile.debug .
# Mac | Windows
docker run -it --name debug-image-go -p 3000:3000 -p 40001:40001 -v $PWD:/go/src/github.com/nmarsollier/imagego debug-image-go

# Linux
docker run -it --add-host host.docker.internal:172.17.0.1 --name debug-image-go -p 3000:3000 -p 40001:40001 -v $PWD:/go/src/github.com/nmarsollier/imagego debug-image-go

El archivo launch.json debe contener lo siguiente

{
    "version": "0.2.0",
    "configurations": [
          {
                "name": "Debug en Docker",
                "type": "go",
                "request": "launch",
                "mode": "remote",
                "remotePath": "/go/src/github.com/nmarsollier/imagego",
                "port": 40001,
                "host": "127.0.0.1",
                "program": "${workspaceRoot}",
                "showLog": true
          }
    ]
}

En el menú run start debugging se conecta a docker.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
model
rest
tools
env

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL