Documentos de Académico
Documentos de Profesional
Documentos de Cultura
1. RESUMEN EJECUTIVO:
3. REQUISITOS FUNCIONALES:
Los siguientes son los requisitos funcionales de los servicios de APIs propuestos:
1
4. ALCANCES Y DESCRIPCIÓN DEL SERVICIO
5. BENEFICIOS
• Escalabilidad y disponibilidad
• Seguridad y autenticación:
• Acceso a información actualizada y precisa
• Consultas rápidas y eficientes
• Seguridad y privacidad de los datos
• Actualizaciones y mejoras continuas
• Base de datos Oracle 12c: Sistema de gestión de base de datos para almacenar y
gestionar los datos del sistema.
• Spring Boot: Framework de desarrollo de aplicaciones Java que simplifica la creación
de microservicios.
• Administración de esquema por usuarios Oracle: Utilización de usuarios específicos
para la administración y gestión del esquema de la base de datos Oracle.
• Hibernate basado en Spring y JPA: Framework de mapeo objeto-relacional para el
acceso a datos en aplicaciones Java basadas en Spring.
• RestControllers: Componentes de Spring para la exposición de APIs REST.
• JWT (JSON Web Tokens): Método de autenticación basado en tokens firmados
digitalmente para garantizar la seguridad de las comunicaciones y la identificación de
los usuarios.
• IDEs de desarrollo: Spring Suite Tools e IntelliJ IDEA para el desarrollo de los
microservicios.
• DBeaver: Herramienta de gestión de bases de datos para administrar y consultar la
base de datos Oracle.
• Bitbucket: Plataforma versátil y potente para la gestión de repositorios de código fuente
y la colaboración en línea. Facilita la colaboración en equipo, el control de versiones, la
revisión de código y la integración con otras herramientas de desarrollo, lo que
2
contribuye a una mayor productividad y eficiencia en los proyectos de desarrollo de
software.
• Docker: Se utilizará Docker para crear contenedores ligeros y portátiles que encapsulen
los microservicios, sus dependencias y configuraciones. Esto permitirá una fácil
implementación y despliegue de los microservicios en diferentes entornos.
• SonarQube: Herramienta de análisis estático de código que ayuda a evaluar y mejorar
la calidad del código en proyectos de desarrollo de software. Proporciona análisis
detallado, detección de problemas, seguimiento de métricas y monitoreo continuo de la
calidad del código, lo que contribuye a un código más limpio, seguro y mantenible.
• Postman: Herramienta versátil y potente para probar y documentar APIs. Facilita la
realización de pruebas de API, la automatización de pruebas, la documentación
interactiva, la colaboración en equipo y la integración con otras herramientas de
desarrollo. Postman es ampliamente utilizado por desarrolladores y equipos de
desarrollo para mejorar la calidad y la eficiencia en el desarrollo de APIs.
• Swagger: Herramienta poderosa para diseñar, documentar y construir APIs de forma
eficiente. Proporciona una especificación estándar y comprensible (OpenAPI) que
permite describir las APIs de manera clara y detallada. Swagger ofrece documentación
interactiva, generación de código, validación y una integración fluida con otras
herramientas de desarrollo, lo que contribuye a un desarrollo de APIs más rápido y
eficiente.
La documentación de arquitectura tiene como objetivo principal proporcionar una visión general
de alto nivel de la arquitectura propuesta. Incluye los siguientes elementos:
3
funciones y responsabilidades de cada componente, así como las tecnologías y
herramientas utilizadas en su implementación.
Por otro lado, la documentación de API se centra en describir los servicios de API implementados
y cómo interactuar con ellos. Esta documentación incluirá los siguientes elementos:
• Endpoints y operaciones: Se detallarán los endpoints disponibles para cada API y las
operaciones que se pueden realizar en cada uno, como GET, POST, PUT, DELETE, etc.
Se describirán los parámetros de entrada, las respuestas esperadas y los posibles
códigos de estado HTTP.
La documentación de arquitectura y API proporciona una guía completa y detallada para los
desarrolladores, usuarios y otros interesados en comprender y utilizar la arquitectura de software
y las APIs implementadas. Facilita la comprensión de la estructura y el funcionamiento del
sistema, promueve las mejores prácticas de desarrollo y mejora la colaboración entre los equipos
de desarrollo y los usuarios finales.
9. RECURSOS HUMANOS:
4
10. PROPUESTA ECONÓMICA:
Nota: El costo del desarrollo del sistema de actualización de datos del colegiado no incluye
el costo de alojamiento en la nube, existiendo muchos proveedores para alojar el sistema
tanto para el backend como frontend.
12. ENTREGABLES
Los entregables deberán ser presentados a través de la Mesa de Partes del Colegio de
Ingenieros del Perú, ubicado en Calle Barcelona Nº 240, San Isidro, o a través de la
ventanilla electrónica del CIP.
Entregable 1:
Informe que deberá de contener los documentos del resultado de las actividades descritas
en el numeral (2.- ALCANCES Y DESCRIPCIÓN DEL SERVICIO), para cada una de las
siguientes funcionalidades:
Entregable 2:
Informe que deberá de contener los documentos del resultado de las actividades descritas
en el numeral (2.- ALCANCES Y DESCRIPCIÓN DEL SERVICIO), para cada una de las
siguientes funcionalidades:
5
Plazo de Entrega: Dentro de un plazo máximo de noventa (90) días calendario, contados
a partir del día siguiente de notificada la orden de servicio y/o suscrito el contrato.
El costo del servicio incluye los impuestos de ley y cualquier otro concepto que incida sobre
el costo total del servicio, debiéndose abonar en cuatro (03) cuotas, según siguiente detalle:
o Primer pago: 1/2 del monto total del servicio, previa presentación y conformidad
del primer entregable.
o Segundo pago: 2/2 del monto total del servicio, previa presentación y conformidad
del segundo entregable.
15. CONFORMIDAD