Giter Club home page Giter Club logo

tpe-web2-api's Introduction

Trabajo práctico especial (2da parte)- Web 2

API Celulares

Desarrollado por

  • Mateo Fernandez

Descripción del proyecto

Dando continuidad al proyecto iniciado en https://github.com/mateoymichis/tpe-web2, se desarrolla una API RESTful que utiliza la misma base de datos del proyecto anterior. Se utilizaron las tecnologías trabajadas en la materia, por lo que este sitio cuenta con:

  • PHP como lenguaje de desarrollo server side.
  • MySQL como sistema de gestión de bases de datos.

Endpoints

Todas las rutas indicadas son a partir de la URL base.

Elemento Valor
Descripción Retorna una lista con todos los celulares. Puede paginarse, ordenarse y filtrarse
Endpoint /api/celulares
Verbo HTTP GET
Parámetro opcional order (id, modelo, descripcion, imagen, marca)
Parámetro opcional direction (asc, desc)
Parámetro opcional filter (modelo, descripcion, imagen, marca)
Parámetro opcional value (string)
Parámetro opcional lower (numero mayor o igual a 0) (0)
Parámetro opcional results (numero mayor a 0 y menor a 51) (10)
Códigos de respuesta 200, 400, 404
Ejemplo de request GET http://localhost/tpe/api/celulares?order=descripcion&direction=desc&filter=marca&value=moto&lower=0&results=5
Elemento Valor
Descripción Retorna un celular dado su id
Endpoint /api/celulares/:ID
Verbo HTTP GET
Parámetro ID (numero positivo)
Códigos de respuesta 200, 404
Ejemplo de request GET http://localhost/tpe/api/celulares/12
Elemento Valor
Descripción Crea un celular dado un json con sus atributos y valores (token requerido)
Endpoint /api/celulares
Verbo HTTP POST
Body Json con modelo, descripcion, imagen, marca_id
Códigos de respuesta 201, 401, 404
Ejemplo de request POST http://localhost/tpe/api/celulares
Ejemplo de body {"modelo": "C115", "descripcion":"Gran celular retro","imagen":"http://server.com/imagen546", "marca_id":2}
Elemento Valor
Descripción Elimina un celular dado su id (token requerido)
Endpoint /api/celulares/:ID
Verbo HTTP DELETE
Parámetro ID (numero positivo)
Códigos de respuesta 200, 401, 404
Ejemplo de request DELETE http://localhost/tpe/api/celulares/12
Elemento Valor
Descripción Edita un celular dado su id (token requerido)
Endpoint /api/celulares/:ID
Verbo HTTP PUT
Parámetro ID (numero positivo)
Códigos de respuesta 200, 401, 404
Ejemplo de request PUT http://localhost/tpe/api/celulares/12
Ejemplo de body {"modelo": "C115", "descripcion":"Gran celular retro","imagen":"http://server.com/imagen546", "marca_id":2}
Elemento Valor
Descripción Inicia sesión dado email y contraseña y retorna un bearer token
Endpoint /api/login
Verbo HTTP POST
Body Json con email y password
Códigos de respuesta 200, 400, 404
Ejemplo de request POST http://localhost/tpe/api/login
Ejemplo de body {"email": "[email protected]", "password":"user"}
Elemento Valor
Descripción Crea un usuario dado email y contraseña
Endpoint /api/usuario
Verbo HTTP POST
Body Json con email y password
Códigos de respuesta 201, 400, 404
Ejemplo de request POST http://localhost/tpe/api/usuario
Ejemplo de body {"email": "[email protected]", "password":"user"}
Elemento Valor
Descripción Retorna una lista con todas las marcas
Endpoint /api/marcas
Verbo HTTP GET
Códigos de respuesta 200, 404
Ejemplo de request GET http://localhost/tpe/api/marcas
Elemento Valor
Descripción Retorna una marca dado su id
Endpoint /api/marcas/:ID
Verbo HTTP GET
Parámetro ID (numero positivo)
Códigos de respuesta 200, 404
Ejemplo de request GET http://localhost/tpe/api/marcas/12
Elemento Valor
Descripción Crea una marca dado un json con sus atributos y valores (token requerido)
Endpoint /api/marcas
Verbo HTTP POST
Body Json con nombre, cuit
Códigos de respuesta 201, 400, 401, 404
Ejemplo de request POST http://localhost/tpe/api/marcas
Ejemplo de body {"nombre": "Nokia", "cuit": "30684125792"}
Elemento Valor
Descripción Elimina una marca dado su id (token requerido)
Endpoint /api/marcas/:ID
Verbo HTTP DELETE
Parámetro ID (numero positivo)
Códigos de respuesta 200, 401, 404
Ejemplo de request DELETE http://localhost/tpe/api/marcas/12
Elemento Valor
Descripción Edita una marca dado su id (token requerido)
Endpoint /api/marca/:ID
Verbo HTTP PUT
Parámetro ID (numero positivo)
Códigos de respuesta 200, 401, 404
Ejemplo de request PUT http://localhost/tpe/api/marcas/12
Ejemplo de body {"nombre": "Nokia", "cuit": "30684125792"}

tpe-web2-api's People

Contributors

mateoymichis avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.