Definición de lineamiento de creación de APIs MID y CRUD

[milo19980525]

Se requiere definir el lineamiento de implementación de APIs MID y CRUD de la OATI con base en #79.

Especificaciones técnicas

• Se debe definir el lineamieno de creación para cada uno de los tipos de APIs (CRUD y MID), a partir de la herramienta Higen.

Sub Tareas

• [x] Integrar Higen con Github y terminar de definir parámetros faltantes de las plantillas en los repositorios.
• [x] Desarrollar un documento técnico para la implementación de nuevos repositorios de APIs MID y CRUD a partir de la herramienta Higen.
• [x] A partir del documento generado escribir el lineamiento en el repositorio: https://github.com/udistrital/lineamientos_oas.

Criterios de aceptación

• [x] Se define el documento técnico asociado a la implemenatación de nuevos repositorios.
• [x] Se actualizan los lineamientos para creación de nuevos repositorios.

Requerimientos

• [x] Revisión y análisis de herramientas de automatización
• [X] Establecimiento de la herramienta de automatización y pruebas de concepto.

Dependencias

• No presenta.

Definition of Ready - DoR

• [x] Está refinada y estimada en puntos de historia por el equipo.
• [x] Incluye la descripción y criterios de aceptación, con el detalle funcional y especificaciones técnicas, de forma entendible por cualquier miembro del equipo.
• [x] No tiene bloqueos que impidan su ejecución.
• [x] Las dependencias entán identificadas y resueltas.
• [x] Puede ser probada dentro del Sprint.

Definition of Done - DoD - Desarrollo

• [x] Criterios de aceptación cumplidos.
• [x] Documentación de issue realizada.
• [x] Aprobada por SM/Líder técnico.

[a52290451]

Actualización de estado de actividades

1. Se realiza la corrección de la plantilla "plantilla_api_crud" integrando cambios asociados al refactor de APIs CRUD y la migración:

https://github.com/udistrital/plantilla_api_crud/pull/1

2. Se realiza la actualización del instructivo de instalación para la plantilla "plantilla_api_crud":

https://github.com/udistrital/plantilla_api_crud/pull/3

4. Se realiza la actualización del instructivo de instalación para la plantilla "plantilla_api_mid":

https://github.com/udistrital/plantilla_api_mid/pull/3

5. Se realiza la actualización de lineamientos asociados con la inclusión de plantillas para creación de APIs MID y CRUD en GO con Hygen:

https://github.com/udistrital/lineamientos_oas/pull/41

[a52290451]

Se adjunta manual técnico para la creación de APIs en GO utilizando plantillas de código implementadas en Hygen:

https://udistritaleduco-my.sharepoint.com/:w:/g/personal/computo_udistrital_edu_co/EcAkiNUsry9NtjeXPiUGiFMB93_yIYFC4ga4YiLSV2Qopg?e=MG73eP

Nota: el manual aún se encuentra sin terminar.

[milo19980525]

@ludwinggsanchez por favor revisar la estructura de las plantillas para el API MID y API CRUD definidas en: https://github.com/udistrital/plantilla_api_mid https://github.com/udistrital/plantilla_api_crud

[a52290451]

Se realiza la actualización del manual técnico completando el contenido de las secciones faltantes.

[ludwinggsanchez]

• Considerar que los nuevos apis sean creados con beego v2 (api ejemplo con beego v2) arka_mid
• Para los modelos y controladores de los apis crud, revisar el uso de beego para generar controladores y modelos con bee generate appcode