Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pedroobando/apirecipe
Un proyecto API RESTful de recetas de cocina - un sencillo ejemplo
https://github.com/pedroobando/apirecipe
crud nodejs postman sequelize
Last synced: 1 day ago
JSON representation
Un proyecto API RESTful de recetas de cocina - un sencillo ejemplo
- Host: GitHub
- URL: https://github.com/pedroobando/apirecipe
- Owner: pedroobando
- License: mit
- Created: 2017-08-24T02:43:58.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-09-13T01:00:11.000Z (over 7 years ago)
- Last Synced: 2024-11-10T14:46:18.800Z (about 2 months ago)
- Topics: crud, nodejs, postman, sequelize
- Language: JavaScript
- Size: 61.5 KB
- Stars: 6
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## APIRECIPE
Tutorial o ejemplo de un simple APIRESTful -
### Descripcion
Desarrollo de API REST para recetas de cocina. el cual realiza un CRUD en la base de datos.
Este API, lugo sera consumido por una aplicacion realizada en VUEJS 2.0 producto (CRUD)
Fecha de inicio del cursillo: 2017-AGO-20
### Desarollado bajo
- node.js (v6.10.0)
- express
- sequelize
### Base de datos
- sqlite3 [Testing](https://www.sqlite.org/)
- Postgres [Produccion](https://www.postgresql.org/)
### Usando Token & Postman
- [JWT](https://jwt.io/)
- [Postman](https://www.getpostman.com/) Para ver y verificas las API's
### Api operaciones con la Base Datos
```markdown
La base de datos debe esta previamente creada cuando se trabaja con postgres
`http://recipe.com/createdb`: inicializa la base de datos
`http://website.com/createdemo`: inicializa y agrega contenido
`http://website.com/conectdb`: verifica la conexion
```
### Api Category (Categorias)
```markdown
Esto indica las posibles categorias de la recetas
Ejemplo: Almuerzo, Postres, Recetas Abuela, Sopas, Preferia, etc.
`http://localhost:3000/category`: Muestra todas los elementos registradas
paramentros: order=[ASC/DESC] limit=[int] page=[int]
`http://localhost:3000/category/:id`: Muestra un elemento especifico.
`http://localhost:3000/category/faker`: Agrega elementos a la base datos para demostrar.
`http://localhost:3000/category/faker/:totalElment`: Agrega la cantidad de elementos a las diferentes tabla de la base datos para demostrar.
`post - http://localhost:3000/category`: Agrega un registro completo.
`put - http://localhost:3000/category/:id`: Actualiza el registro completo.
`patch - http://localhost:3000/category/:id/active`: Activa o desactivo el registro completo.
`delete - http://localhost:3000/category/:id`: Elimina el registro.
Tabla Category
`id`: numerico
`name`: caracter o string
`active`: bolean o logico
```
### Api Measure (Medidas)
```markdown
Esto indica las medidas existentes en las recetas.
Ejemplo: Taza, cucharada rasa, gramos, kilos, mili-litros, unidad, etc
`http://localhost:3000/measure`: _Muestra todas las medidas registradas,
parametros:_ **order=**[ASC/DESC] **limit=**[numero] **page=**[nropagina]
`http://localhost:3000/measure/:id`: Muestra una medidas en especifica
`http://localhost:3000/measure/faker`: Agrega elementos a la base datos para demostrar las medidas
`http://localhost:3000/category/faker/:totalElment`: Agrega la cantidad de elementos a las diferentes tabla de la base datos para demostrar las categorias
`post - http://localhost:3000/measure`: Agrega un registro completo
`put - http://localhost:3000/measure/:id`: Actualiza el registro completo
`patch - http://localhost:3000/measure/:id/active`: Activa o desactivo el registro completo
`delete - http://localhost:3000/measure/:id`: Elimina el registro
Tabla Measure
`id`: numerico
`name`: caracter o string
`active`: bolean o logico
```
### Api Ingredient (Ingredientes)
```markdown
Los ingredientes usados para elaborar las recetas
Ejemplo: Ajo, Aji, Carne, Pescado, Tomillo, Fresas, Limon, Naranja, Arina Trigo, etc.
`http://localhost:3000/ingredient`: _Muestra todas las elementos registrados_
`http://localhost:3000/ingredient/:id`: Muestra una elemento en especifico
`http://localhost:3000/ingredient/faker`: Agrega elementos a la base datos para demostrar
`http://localhost:3000/ingredient/faker/:totalElment`: Agrega [N] elementos a las tablas.
`post - http://localhost:3000/ingredient`: Agrega un registro completo
`put - http://localhost:3000/ingredient/:id`: Actualiza el registro completo
`patch - http://localhost:3000/ingredient/:id/active`: Activa o desactivo el registro completo
`delete - http://localhost:3000/ingredient/:id`: Elimina el registro
Tabla Measure
`id`: numerico
`name`: caracter o string
`price`: double o decimales
`active`: bolean o logico
`measure`: objeto medida (relacionado)
```
### Api Recipe (Receta)
```markdown
La receta contiene los ingredientes, las categorias,
Ejemplo: Pollo frito
`http://localhost:3000/recipe`: _Muestra todas las elementos registrados_
`http://localhost:3000/recipe/:id`: Muestra una elemento en especifico
`http://localhost:3000/recipe/faker`: Agrega elementos a la base datos para demostrar
`http://localhost:3000/recipe/faker/:totalElment`: Agrega [N] elementos a las tablas.
`post - http://localhost:3000/recipe`: Agrega un registro completo
`put - http://localhost:3000/recipe/:id`: Actualiza el registro completo
`patch - http://localhost:3000/recipe/:id/active`: Activa o desactivo el registro completo
`delete - http://localhost:3000/recipe/:id`: Elimina el registro
Tabla Recipe
`id`: numerico
`name`: caracter o string
`dificulty`: entero
`portion`: entero
`preparation`: string (forma de preparacion)
`active`: bolean o logico
`categories`: objeto categoria (relacionado)
`ingredients`: objeto ingrediente (relacionado)
```