Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gitfrandu4/express-router-twitter-app
Ejercicio API RESTful con Express
https://github.com/gitfrandu4/express-router-twitter-app
Last synced: 6 days ago
JSON representation
Ejercicio API RESTful con Express
- Host: GitHub
- URL: https://github.com/gitfrandu4/express-router-twitter-app
- Owner: gitfrandu4
- Created: 2021-10-21T02:19:12.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2021-11-05T19:36:22.000Z (about 3 years ago)
- Last Synced: 2023-12-09T19:42:39.065Z (about 1 year ago)
- Language: JavaScript
- Size: 130 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Primera API con 2 recursos
Queremos desarrollar una api restful con node para un proyecto copia de twitter. Aunque de momento, será solo una primera versión con usuarios y tweets como si fuese un blog personal.
## Parte 1: Direccionamiento Express
Deberán estar implementadas las funcionalidades de:
Usuarios:
- [x] Crear un nuevo usuario (POST)
- [x] Borrar un usuario (DELETE)
- [x] Editar el email de un usuario o el nombre (PATCH)
Tweets:
- [x] Subir un tweet nuevo por parte de un usuario
- [x] Ir a buscar un tweet en concreto por su id
- [x] Borrar un tweet por su id
Opcional
- [x] Opcional: Obtener todos los tweets ordenados tanto asc como desc por la fecha de subida
- [x] Opcional: Guardar los usuarios en un fichero db.json y actualizarlo con cada cambio.
- [x] Opcional: Guardar los tweets en un fichero db.json y actualizarlo con cada cambio.
- [x] OBLIGATORIO: Usar router para cada recurso
```javascript
// Action mapping
/**
* GET /api/users -> getAll
* GET /api/users/:username -> getByUsername
* POST /api/users -> create
* PATCH /api/users/:username -> modify
* PUT /api/users/:username -> update
* DELETE /api/users/:username -> destroy
*/
// Export methods
// ============ El tirón con un objeto:
/*module.exports = {getAll: getAll, create: create, modify: modify, destroy: destroy} */
// ============ Truco: Cuando el nombre con el que exportamos y el del método coinciden:
module.exports = { getAll, getTweets, create, modify, destroy };
// ============ Línea a línea:
/* module.exports.getAll = getAll
module.exports.create = create
module.exports.modify = modify
module.exports.destroy = destroy */
```
Controlar:
* Que la API no se queda bloqueada en ningún momento
* Campos vacíos en la request
* Request inválidas
* etc.
Devolver en su caso el error en la respuesta y el código correcto para dicho caso.
## Parte 2: Middlewares
El producto evoluciona => utilizando **middlewares** estaría interesante que :
- [ ] Cuando se produzca un error en nuestra api le llegue un correo al desarrollador con el error.
- [ ] También estaría chulo que si un usuario nos hace más de 20 peticiones POST en una misma sessión no le permitas hacer más peticiones post y nos informes por correo también.
- [ ] Hemos visto que hay muchas herramientas para monitorizar logs por ahí :S Investiga e implementa alguna para controlar todo lo que pasa en nuestro server de express [https://www.slant.co/options/955/alternatives/~loggly-alternatives](https://www.slant.co/options/955/alternatives/~loggly-alternatives)
## Parte 3: Conexión a MongoDB
Guardar los datos del proyecto en mongoDB usando mongoose para conectar nuestra API con la base de datos
- [x] R1. Usuarios
- [x] Definir Schema
- [x] Implementar CRUD de users
```javascript
/**
* GET /api/users -> getAll
* POST /api/users -> create
* PATCH /api/users/:username -> modify
* PUT /api/users/:username -> update
* DELETE /api/users/:username -> destroy
*/
```
- [x] Validaciones con mongoose
- [x] R2. Tweets
- [x] Definir Schema
- [x] Implementar CRUD de users
```javascript
/**
* GET /api/tweets -> getAll
* POST /api/tweets -> createTweet
* GET /api/tweets/:id -> getTweet
* DELETE /api/tweets/:id -> deleteTweet
*/
```
- [x] Validaciones con mongoose
## Parte 4: Mejoras
- [ ] Aplicar paginación a la API
- [ ] Usar queryParams: [vídeo](Path vs Query Parameters in HTTP Requests (with Postman))
- [ ] Investigar como páginar una búsqueda de mongoose
- [ ] Investigar tanto el `limit` como el `skip` y parametrizarlo
- [ ] Frontend
- [ ] Realizar un frontal para nuestro proyecto
Note:
Start node.js app with nodemon (restarts the app when file changes in the directory are detected)
```
nodemon index.js
```