https://github.com/ayvero/api_rest
RESTful API that allows users to manage a collection of clothing items.
https://github.com/ayvero/api_rest
api-rest php
Last synced: 5 months ago
JSON representation
RESTful API that allows users to manage a collection of clothing items.
- Host: GitHub
- URL: https://github.com/ayvero/api_rest
- Owner: Ayvero
- Created: 2022-11-09T21:29:38.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2025-03-28T23:52:44.000Z (6 months ago)
- Last Synced: 2025-03-29T00:28:10.035Z (6 months ago)
- Topics: api-rest, php
- Language: PHP
- Homepage:
- Size: 19.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# API REST para el recurso de clothes
## Pueba con postman
El endpoint de la API es: http://localhost/Proyectoxamp/api-rest-TP2/api/clothes
## Importación de la base de datos
- importar base de datos: database/business.sql
Configuracion de tablas con las que se opera:
Base de datos:
dbname=business
-tabla "clothes":
columnas:
*id
*id_clothes (foreing key)
*description
*size
*colour
*price
*image
*offers
Tabla "brand"
columnas:
*id_brand
*brand
Acceso a los endPoints:
1.- Mostrar todos los datos de la tabla "clothes":
endPoint: Metodo GET- http://localhost/Proyectoxamp/api-rest-TP2/api/clothes
2.- Mostrar los productos ordenados de forma asc o desc , segun una columna de la tabla "clothes":
endPoint: metodo GET-
http://localhost/Proyectoxamp/api-rest-TP2/api/clothes?sort=price&order=asc
Se debe colocar en la variable "sort"= la columna elegida para ordenar(puede ser cualquier columna).
En la variable "order" = se debe colocar "asc" o "desc".
En caso de escribir mal el nombre de la columna o la palabra asc o desc el sistema arrojara error 400, especificando que coloque bien las palabras.
3.- Mostrar los productos especificados por su id:
endPoint: metodo GET-
http://localhost/Proyectoxamp/api-rest-TP2/api/clothes/7
Se debe colocar / y el numero del id a buscar.
En caso de colocar un id inexistente la api arrojara error 404, con el mensaje de "id inexistente".
4.- Insertar datos en la base de datos:
endPoint:metodo POST-
http://localhost/Proyectoxamp/api-rest-TP2/api/clothes
Colocar en formato json todos los atributos a modificar. No dejar ningun campo vacio o el sistema arrojará la advertencia de "completar los datos".
5.- Paginacion en la busqueda de datos:
endPoint: metodo: GET-
http://localhost/Proyectoxamp/api-rest-TP2/api/clothes?select=*&starAt=1&endAt=6
Se debe colocar el nombre de la columna a buscar en la variable "select" . En caso de requerir todas las columnas se debe colocar *.
En la variable "starAt" se coloca el nuemro de filas desde la cual buscar.
En la variable "endAt" colocar el numero de filas hasta el cual se desea buscar.
En caso de colocar un nombre de columna inexistente o que se pida iniciar la búsqueda en un numero inexistente, el sistema avisará del error. En caso de colocar un numero de término mas alto que el total de filas, el sistema traerá todas las que encuentre.
6.- Filtro de búsqueda por campo específico:
endPoint: metodo GET-
http://localhost/Proyectoxamp/api-rest-TP2/api/clothes?column=colour&search=verde
Se debe colocar en la variable "column" el nombre de la columna por la cual buscar.
En la variable "search" se colocará el dato especifico a buscar. Debe ser el dato exacto, bien escrito o el sistema arrojará error.
También es posible buscar en la tabla relacionada por nombre de la marca con la columna "brand".
En caso de escribir mal el atributo o nombre de la columna el sistema arrojará error.
7.- Eliminar un elemento por su id:
endPoint: metodo DELETE-
http://localhost/Proyectoxamp/api-rest-TP2/api/clothes/12
Se debe colocar el id de la fila a eliminar.
En caso de colocar un id incorrecto el sistema avisará que ese id no existe.
8.- Busqueda por 3 columnas.
endPOint. Metodo :GET-
http://localhost/Proyectoxamp/api-rest-TP2/api/clothes?col1=description&col2=price&col3=offers
Se deben colocar los nombres de 3 columnas por las cuales filtrar los datos.
En caso de nombres invalidos de las columnas el sistema expresara el error.
Nota:
Se agregó una columna "offers" a la tabla "clothes", a la cual se puede acceder mediante el metodo get y el endpoint N° 8, colocando en el nombre de una columna : offers.