felixVelazco/w4-code-challenge

Create an API and to access students.json file

w4 - Code Challenge

Author: @felixVelazco

API que permita acceder a diversos datos de un archivo JSON, el cual tiene una lista de objetos con varios estudiantes. El proposito general de la API es:

1. Habilitar un endpoint para consultar todos los estudiantes con todos sus campos.
2. Habilitar un endpoint para consultar los emails de todos los estudiantes que tengan certificación haveCertification.
3. Habilitar un endpoint para consultar todos los estudiantes que tengan credits mayor a 500.

Requisitos

• Instalar node y npm Link a la página de Node

Instalación

• En la carpeta donde quieras tener este repositorio, abre tu terminal y corre

git clone https://github.com/felixVelazco/w4-code-challenge.git

• Ve a la carpeta raiz del proyecto e instala las dependencias de Node.js con

npm install

Diagramas de flujo

graph TD;
  start(Start);
  p2[Run server];
  p3[Access to localhost.com/3000];
  p4[Get All students data];
  p5[Get emails from students with certification];
  p6[Get students data from students with above x credits];
  p7(End);
  
  start-->p2;
  p2-->p3;
  p3-->p4;
  p3-->p5;
  p3-->p6;
  p4-->p7;
  p5-->p7;
  p6-->p7;

Diagrama de clases

 classDiagram      
      class StudentController{
        +getStudents()$
        +getStudentsEmail()$
        +getStudentsCredits(credits)$
      }
      class StudentService{
          +filterStudentsCertification(students)$
          +getStudentsWithCertificationEmail(students)$
          +filterStudentsByCredits(students, credits)$
      }
      class Reader{
          +readJsonFile(path)$
      }
      Reader-->StudentService
      StudentService-->StudentController
      StudentController-->Server

Endpoints

Para acceder a la documentación de los endpoints, da click en el siguiente link:

Documentación endpoint

Procedimiento

El uso de esto es muy sencillo, desde el navegador simplemente utilizas los endpoints que se vieron en el paso anterior.

De igual manera puedes utilizar herramientas como Postman para acceder, a los endpoints