administrativa_NoSQL_api, CRUD para el negocio de novedades, el proyecto está programado en el lenguaje Go y creado con el framework beego.
Instlaciones Previas:
Recomendado:
- MongoDB Compass o Robo T3: Para verificar que los datos se insertan o editan bien.
La base de datos está desarrollada en mongodb y el backup es: backupArgo
Para desplegar en un contenedor se requiere:
Relizar una copia local del siguiente archivo (Descargar o copiar y pegar en un archo .yml): Imagen de Mongodb
y subir el contenedor desde visual studio code, por comando o con PORTAINER.
Y crear una base de datos y subir el backup del proyecto: backupArgo
Ejecutar desde la terminal 'go get repositorio':
go get github.com/udistrital/administrativa_NoSQL_api.git
Para instalar el proyecto realizar los siguientes pasos:
- Para clonar el proyecto en la carpeta local go/src/github.com/udistrital ir a la consola y ejecutar:
cd go/src/github.com/udistrital
- Ejecutar:
git clone https://github.com/udistrital/administrativa_NoSQL_api.git
- Ir a la carpeta del proyecto:
cd administrativa_NoSQL_api
- Instalar dependencias del proyecto:
go get
-
Se debe confirma si las credenciales para la conexión a la base de datos está correctamente:
- mongo_host = Puerto por el que está expuesto mongo.
- mongo_db= Nombre de la base de datos.
- mongo_user = Usuario que se creó en mongo para la conexión.
- mongo_pass = Contraseña del usuario.
-
El puerto por el que se expone la api httpport = 8083; si se cambia de puerto se debe editar la configuración en el cliente, especificamente la varible de entorno ARGO_NOSQL_SERVICE.
- Ubicado en la raíz del proyecto, ejecutar:
bee run
- O si se quiere ejecutar el swager:
bee run -downdoc=true -gendoc=true
-
El servidor se expone en el puerto: localhost:8083
-
Para ver la documentación de swagger: localhost:8083/swagger/ Nota: En el swagger sale un error, hacer caso omiso.
Cada modelo tiene los metodos :
- GetAll
- GetOne
- Put
- Delete dependiendo de cualquiera usar lo define al momento de consumir el servicio, los endpoint a los cuales apuntar son los siguientes:
End Point | |
---|---|
actainicio | [host de la maquina]:[puerto]/v1/actainicio |
novedad | [host de la maquina]:[puerto]/v1/novedad |
plantilladocumento | [host de la maquina]:[puerto]/v1/plantilladocumento |
tiponovedad | [host de la maquina]:[puerto]/v1/plantilla_minuta |