{{Describe de forma breve y clara la finalidad del microservicio. Explica qué problema resuelve o qué necesidad cubre.}}
{{Indica si existe un documento MSA asociado. Si aplica, incluir el enlace; si no, especificar "N/A".}}
{{Especifica qué tipo de artefacto es: service, library, job, microfront, lambda, monolith, poc, etc.}}
{{Lista de herramientas, versiones mínimas y configuraciones necesarias para que un desarrollador pueda compilar y ejecutar el servicio localmente.}}
- IDE recomendado
- Versión mínima de Java, Maven u otros
- Dependencias externas (ej. Docker, Node, librerías adicionales)
{{Detalla todas las variables de entorno necesarias para la ejecución del microservicio, con una breve explicación de su uso.}}
| Variable | Descripción | Valor esperado o por defecto |
|---|---|---|
spring.profiles.active |
Define el perfil de ejecución (local, dev, qa, prod) | local |
security.basic.username |
Usuario de autenticación básica | username |
| … | … | … |
{{Si el servicio requiere certificados o llaves, documentar ubicación, propósito y cómo obtenerlos.}}
{{Describe paso a paso cómo importar, configurar y ejecutar el proyecto en un IDE o en consola.}}
- Pasos para clonar el repositorio
- Pasos para importar el proyecto (IntelliJ, Eclipse, VSCode, etc.)
- Configuración de Maven/Gradle (si aplica)
- Cómo agregar variables de entorno al perfil de ejecución
{{Indica cómo levantar el microservicio en ambiente local.}}
- Pasos para crear configuración de ejecución
- Clase principal a ejecutar
- Puerto por defecto en el que levanta el servicio
- Mensaje esperado en consola al iniciar correctamente
{{Describe cómo se despliega el microservicio en ambientes remotos.}}
- Indicar si usa pipelines estandarizados (con link a Jenkins/GitLab/GitHub Actions)
- Explicar si existen pasos adicionales antes del despliegue (ej. configuración en Nexus, Artifactory, Docker registry)
{{Explica cómo consumir el servicio una vez desplegado.}}
- URL base de cada ambiente (dev, qa, prod)
- Endpoints disponibles y su propósito
- Esquema de autenticación requerido (ej. basic auth, token JWT)
- Ejemplo de pruebas rápidas (con curl, Postman, etc.)
{{Documenta la estrategia de logging utilizada.}}
- Nombre del log set y log específico
- Ubicación o sistema de consulta (ej. Dynatrace, Kibana, CloudWatch)
- Convenciones de formato si aplican
{{Incluye recomendaciones específicas para el desarrollo o ejecución.}}
- Generales: limitaciones conocidas, dependencias críticas, configuraciones extra
- Eclipse: pasos adicionales si el proyecto debe abrirse en este IDE
- IntelliJ: plugins recomendados o configuraciones adicionales
{{Agrega enlaces a documentación relevante}}
- Diagramas de arquitectura
- Diseño de APIs (ej. Swagger)
- Confluence, Sharepoint o documentación oficial