Código boilerplate para construir proyectos API basados en nodejs con fastify y postgres sql, esta es una estructura base que se puede usar como inicio
src\
|--controllers\ # Controladores que se conectan a un route
|--models\ # Modelos
|--routes\ # Rutas
|--services\ # Servicios que se conectan a la base de datos
|--index.js # Aplicación
- Method:
POST
- Endpoint:
/api/v1/users
- Params:
{
"firstname": "Nombres",
"lastname": "Apellidos",
"email": "Email"
}
- Method:
PATCH
- Endpoint:
/api/v1/users/{id}
- Params:
{
"firstname": "Nombres",
"lastname": "Apellidos",
"email": "Email"
}
Mediante este endpoint puedes obtener usuarios devolviendo una estructura variable además de la posibilidad de poder realizar filtros.
Para configurar los campos a devolver de la consulta se debe enviar en el query la variable fields
con los campos separados por comas
Ejemplo:
?fields=firstname,lastname,id
=> Esto devolverá solo el firstnam
, lastname
e id
Para configurar el filtro a realizar se debe enviar en el query el campo y el valor que se quiere filtrar, para la version actual solo hace filtros con el comparador =
Ejemplo:
?id=2&firstname=Jon
=> Esto filtrará los usuarios que tengan como id = 2
y firstname = Jon
- Method:
GET
- Endpoint:
/api/v1/users/?fields=firstname,id&firstname=Jon&lastname=Doe