utils_oas

Este es un paquete de librerías y utilidades generales para las aplicaciones desarrolladas en el framework beego que hacen parte de la arquitectura de APIs REST de la OAS.

Librerías Incluídas

apiStatusLib (:heavy_check_mark:)

Para desplegar satisfactoriamente un api dentro de la infraestructura de la OAS, se debe crear un servicio el cual será constantemente consultado para verificar el estado de salud del mismo, esto se conoce como health check. El apiStatusLib Proporcion un servicio en la rais de la API con estadus 200.

customerror (:heavy_check_mark:)

La utilidad customerror proporciona a la estructura beego.Controller unas plantillas de error que retornan una estructura json en todos los servicios del API. Establece adecuadamente el estatus correspondiente para cada servicio al ser una ejecución exitosa o fallida según el código de estado HTTP. Para implementar esta utilidad se debe refactorizar el api con el siguiente programa. refactor_controller

customerrorv2 (:heavy_check_mark:)

Corresponde a la versión 2 del customerror. Se mejora la implementación del json en la respuesta de los servicios. Se mitiga la exposición de información confidencial en la estructura de errores.

formatdata

Funcionalidades para la conversión y trabajo de estructuras JSON

optimize

Funcionalidades de optimización con procesamiento de datos en golang

request

Funcionalidades para el consumo de servicios JSON desde una API

ruler

Funcionalidades para las reglas de negocio

security

Funcionalidades de seguridad para aplicaciones híbridas o legadas.

time_bogota

Implementación

importar: ```go "github.com/udistrital/utils_oas/time_bogota" ``` 3 funcinalidades: - Tiempo_bogota : Da la hora de Bogota sin importar la zona horaria de la maquina o contenedor **_usar en codigo (remplarar)_** ```go VariableDeTiempo = tiem.Now() ``` por ```go VariableDeTiempo = time_bogota.Tiempo_bogota() ``` - TiempoBogotaFormato() **_(Nota : esta funcion funciona perfectamente en peticiones POST, para los put puede mandar lio asi que se recomienda usar para los PUT la tercera funcion aqui nombrada)_** Esta funcion da el formato para la hora y que esta sea aceptada por la base de datos. ya que esta funcion retorna un string, se debe cambiar en los modelos del api donde se quiera usar la funcion, esto evitara problemas con la hora y que genere una hora con UTC 0 **_en codigo_** ```go type ResolucionEstado struct { Id int FechaRegistro time.Time Usuario string Estado *EstadoResolucion Resolucion *Resolucion } ``` por ```go type ResolucionEstado struct { Id int FechaRegistro string Usuario string Estado *EstadoResolucion Resolucion *Resolucion } ``` *** ```go VariableDeTiempo = tiem.Now() ``` por ```go VariableDeTiempo = time_bogota.TiempoBogotaFormato() ``` - TiempoCorreccionFormato(inputDate string): Esta funcion recibe un string y devuelve otro transformado, esta funcion surge como solucion al problema de que las fechas al traerlas de la base de datos pueden llegar en el siguiente formato `2019-10-08 18:26:45.58 +0000 +0000`, este formato al hacer un update en la base de datos provoca errores, por ende esta funcion realiza la correccion para usarla se usara el siguiente ejemplo, suponga que de la base de datos trae una fecha y se llama `FechaFin` y su valor al imprimirlo es el siguiente : `2019-10-08 18:26:45.58 +0000 +0000` para corregirlo realice lo siguiente: ```go FechaFin = time_bogota.TiempoCorreccionFormato(FechaFin) ``` esto le devolvera la fecha en el siguiente formato : `2019-10-08T18:26:45.58Z` el cual la ase de datos recibira.

Desarrollo

Teniendo en cuenta que este paquete es de utilidades, es de esperar que en vez se trabajarse por aparte, se valide con otra aplicación que importe este paquete. Asumiendo que los siguientes comandos se ejecutan desde una aplicación que importa este paquete, por ejemplo, desde configuracion_crud; Se propone el siguiente flujo de desarrollo:

# 1. Desde el repositorio que importe esta librería, ej, configuracion_crud
# Indicarle al go.mod que reemplace utils_oas con una version local
go mod edit -replace github.com/udistrital/utils_oas=../utils_oas

# 2. Sincronizar los go.mod/sum - Al ser un reemplazo temporal, deberá ignorarse
# mas adelante en el commit, ojo!
go mod tidy

# ------- Hacer pruebas y ajustes necesarios en ambos repositorios -----------

# 3. Una vez finalizadas las pruebas, abrir un PR en utils_oas
# Y DESCARTAR LOS CAMBIOS A LOS go.mod/sum derivados de 1. y 2.:
git checkout go.mod go.sum

# 4. Una vez aprobado el PR en utils_oas, lo único que resta es actualizar
# la versión importada en el/los repos que importen utils_oas, simplemente con
go get -u github.com/udistrital/utils_oas

Licencia

This file is part of utils_oas.

utils_oas is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Foobar is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Foobar. If not, see https://www.gnu.org/licenses/.

udistrital / utils_oas

readme