Conexión Viajera
Esta es una página web desarrollada para la empresa Conexión Viajera, dedicada a la Publicidad Turística en el Municipio Juan German Roscio en San Juan de los Morros.
📂 Estructura de carpetas
├──ConexionViajera (root)
│ ├── client (frontend folder)
│ │ └── public
│ │ └── src
│ ├── controllers
│ ├── models
│ ├── routes
👩💻 Para desarrolladores 👨💻
-
Asegúrense estar posicionados en el root del proyecto:
./conexionviajera/
-
Para instalar todas las dependencias, usen el comando:
npm run install-all
-
Una vez instaladas las dependencias, deben iniciar el proyecto con el comando:
npm run dev
🏓 La API
La API esta desarrollada en un servidor Express.js
, el cual se inicia junto con el servidor frontend al hacer uso del npm run dev
.
Por defecto el puerto del servidor es 8080
en el modo development
, pero podría ser cualquier otro al entrar en producción, haciendo uso de la variable de entorno PORT
.
El archivo vite.config.js
ya esta configurado para redireccionar todas las consultas HTTP
a la dirección URL http://localhost:8080
que pasen por el endpoint:
/api
📃 Como usarla
La API responde a dos de los métodos HTTP
más usados: GET
y POST
. Todas las respuestas devolverán datos en json
.
GET
El método GET
de esta API, solo tiene un uso:
Obtener todos los comentarios existentes.
La manera de hacerlo sería la siguiente:
GET /api/reviews
{
"status": 200,
"success": true,
"content": [
{
"name": "Jonaiker Jaspes",
"location": "Estado Aragua, Venezuela",
"review": "Fino 👍"
},
// ...
]
}
POST
El método POST
de esta API, solo tiene un uso:
Enviar a la base de datos la reseña del formulario.
La manera de hacerlo sería la siguiente:
POST /api/reviews
{
"name": "Génesis Sumoza",
"review": "Malo 👎"
}
{
"status": 200,
"success": true,
"content": {
"name": "Génesis Sumoza",
"location": "Distrito Federal, Venezuela",
"review": "Malo 👎"
}
}