Ejecución

Para ejecutar este back debe clonar el repositorio, ingresar a la carpeta del proyecto (cd 202310_Parcial2_Back), instalar dependencias (npm install) e iniciar el servidor de desarrollo (npm start). Esto desplegará un servidor web que escucha peticiones en el puerto 3001.

Si hace una petición de tipo GET a la ruta por defecto (http://localhost:3001) deberá recibir un status code 200 con el siguiente mensaje:

{
    "status": "Success",
    "message": "The backend is running"
}

Endpoints

Este backend proporciona tres endpoints:

POST /login

Este endpoint recibe en el cuerpo de la petición un objeto con dos atributos: login y password. Si las credenciales proporcionadas son correctas retornará un status code 200 con el siguiente mensaje:

{
    "status": "success",
    "message": "The provided credentials are correct. User authenticated."
}

Si las credenciales son incorrectas retornará un status code 401 con el siguiente mensaje:

{
    "status": "error",
    "message": "The provided credentials are incorrect."
}

Para efectos de prueba use las siguientes credenciales para una autenticación correcta:

{
    "login": "admin",
    "password": "pass"
}

GET /cafes

Este endpoint retorna un listado de cafés. Este es un ejemplo de la respuesta:

[
    {
        "id": 1,
        "nombre": "Café Especial para tí",
        "tipo": "Blend",
        "region": "Angelópolis, Antioquia"
    },
    {
        "id": 2,
        "nombre": "Café Especial Navegante",
        "tipo": "Café de Origen",
        "region": "Guatapé, Antioquia"
    }
]

GET /cafes/{{cafe_id}}

Este endpoint retorna el café con el id pasado como parámetro en el path. Este es un ejemplo de la respuesta:

{
    "id": 1,
    "nombre": "Café Especial para tí",
    "tipo": "Blend",
    "region": "Angelópolis, Antioquia",
    "notas": "Panela, Durazno, Caramelo",
    "fecha_cultivo": "2023-01-18",
    "altura": 1920,
    "imagen": "https://github.com/Uniandes-isis2603/recursos-isis2603/blob/master/images/202310/p2_v1/cafe-especial-para-ti-cafe-colombiano_720x.png?raw=true"
}

Si el café con el id proporcionado no existe retornará un status code 404 con la siguiente respuesta:

{
    "status": "error",
    "message": "The coffe with the given id was not found."
}