Implementación microservicio Ágora MID - Parte 2

[edwargl7]

Se requiere continuar con el desarrollo del endpoint de consulta de proveedor por documento de identidad trabajada inicialmente en la Issue #61, siguiendo el formato de respuesta.

Sub Tareas

• [x] Implementación del endpoint de consulta de proveedor por documento de identidad.
• [x] Implementación del endpoint de consulta del representante legal por id del proveedor, que se relaciona al id proveedor retornado por el endpoint anterior, que en caso de ser persona jurídica suministra la información del representante legal.
• [x] Implementación endpoint Health Check.
• [x] Pruebas del correcto funcionamiento del endpoint.

Criterios de aceptación

• [x] Implementación de los endpoints siguiendos los lineamientos requeridos para el nombre de los endpoints y el desarrollo del health check (se encuentran al final de este Issue), con sus respectivas evidencias de las pruebas realizadas.

Requerimientos

• Endpoints y consulta a base de datos compartida.

Material de apoyo

• Relación entre las tablas que almacenan la información del proveedor y del representante legal.

Especificaciones técnicas

1. Repositorio de microservicio proveedores_mid.

Lineamientos Generales Lineamientos que se deben cumplir en cualquier desarrollo.

1. Lineamiento y Metodología para Branches
2. Etiquetas en comentarios de Commits
3. Seguir los lineamientos para la documentación del README Contenido README

Lineamientos Microservicios

1. Definición de endpoints para APIs REST Hoja resumen de buenas prácticas y Aclaración y ejemplos de nombres adecuados para endpoints
2. Guiarse en la construcción del microservicio basado en los lineamientos de APIS Beego si se usa Golang
3. Guiarse de los lineamientos de ambientes dockerizados
4. (health check) validación de estado en APIs

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 están identificadas y resueltas.
• [x] Puede ser probada dentro del Sprint.

Definition of Done - DoD - Desarrollo

• [x] Desarrollo en local.
• [x] Push en Feature.
• [x] Pruebas locales (funcionales).
• [x] PR a Develop.
• [x] Criterios de aceptación cumplidos.
• [x] Documentación de issue realizada.
• [x] Aprobada por SM/Líder técnico.

[mau-oati]

Duda:

La respuesta del primer endpoint, cuando trae datos de proveedor de persona natural, no deja muy claro si la ciudad de expedicion est'a presente. Es ciudad_contacto?

[mau-oati]

En el caso de persona juridica, esa informaci'on se obtiene del segundo endpont. 😁

[edwargl7]

:boom: Pendiente ajuste consulta para agregar ciudad de expedición. Es correcto el endpoint de representante legal cuenta con el campo de ciudad de expedición del documento.

[edwargl7]

La solución planteada para obtener el lugar de expedición se planteo usando el mismo endpoint de datos de representante legal, sin embargo, se replantea para complementar ese dato en el endpoint de proveedor que aplica solo para persona natural.

[mau-oati]

Para el cierre nos queda confirmar si tenemos el update del endpoint para hacer una sola solicitud cuando es persona natural o si seguimos con las dos para obtener el dato de cuidad de expedición 👌

[edwargl7]

Actualizado el endpoint con el campo de ciudad_expedicion_documento que aplica para persona natural. En caso de ser persona jurídica se retorna vacio.

[edwargl7]

Se comparte por interno los datos de pruebas que se pueden usar.

[mau-oati]

Persona Natural:

{
  "Success": true,
  "Status": 200,
  "Message": "Proveedor Encontrado",
  "Data": {
    "proveedor": {
      "id_proveedor": "21339",
      "ciudad_expedicion_documento": "Kabul",
      "id_ciudad_contacto": "3060",
      "direccion": "AVIAL 1 1 1  ",
      "numero_documento": "111111111",
      "nombre_estado": "ACTIVO",
      "numero_cuenta_bancaria": "11111111",
      "id_ciudad_expedicion_documento": "45",
      "id_estado": "1",
      "nombre_completo_proveedor": "1 1 1 1",
      "ciudad_contacto": "Puerto Narino",
      "web": "",
      "fecha_registro": "2023-06-30 - 12:15:21 PM",
      "correo": "sasa@gmail.com",
      "id_entidad_bancaria": "0",
      "tipo_persona": "NATURAL",
      "tipo_cuenta_bancaria": "AHORROS",
      "fecha_ultima_modificacion": "2023-06-30 - 12:15:21 PM"
    }
  }
}

Persona Juridica:

[mau-oati]

Caso: No Encontrado:

{
  "Success": false,
  "Status": 404,
  "Message": "Proveedor no encontrado"
}

[edwargl7]

Muy buen trabajo, cumple con el desarrollo solicitado siguiendo los lineamientos y una implementación clara.

Ejemplo suministrado por @mau-oati.

// http://localhost:3000/contratista?id=899999230

{
  "Success": true,
  "Status": 200,
  "Message": "Proveedor Encontrado",
  "Data": {
    "proveedor": {
      "id_proveedor": "3146",
      "ciudad_expedicion_documento": null,
      "id_ciudad_contacto": "96",
      "direccion": " CR 7 40 B 53",
      "numero_documento": "899999230",
      "nombre_estado": "ACTIVO",
      "numero_cuenta_bancaria": "230053548",
      "id_ciudad_expedicion_documento": null,
      "id_estado": "1",
      "nombre_completo_proveedor": "UNIVERSIDAD DISTRITAL FRANCISCO JOSÉ DE CALDAS",
      "ciudad_contacto": "Bogotá D.C.",
      "web": "www.udistrital.edu.co",
      "fecha_registro": "2017-07-05 - 01:24:01 PM",
      "correo": "computo@udistrital.edu.co",
      "id_entidad_bancaria": "23",
      "tipo_persona": "JURIDICA",
      "tipo_cuenta_bancaria": "CORRIENTE",
      "fecha_ultima_modificacion": "2017-07-05 - 01:24:01 PM"
    },
    "representante": {
      "segundo_apellido": "SUÁREZ",
      "tipo_documento": "CÉDULA DE CIUDADANÍA",
      "ciudad_expedicion_documento": "Bogotá D.C.",
      "genero": "MASCULINO",
      "numero_documento": "79296179",
      "primer_apellido": "MOSQUERA",
      "segundo_nombre": "JAVIER",
      "digito_verificacion": "7",
      "id_tipo_documento": "7",
      "id_ciudad_expedicion_documento": "96",
      "primer_nombre": "CARLOS",
      "id_proveedor_juridico": "3146"
    }
  }
}