API REST Recurso Individual - Uniandes-ISIS2603-backup/201620-g5 GitHub Wiki
###Implementación de los Servicios REST para el recurso “Biblioteca” de la aplicación Biblioteca del grupo de trabajo “G5”
Implementado por Santiago Múnera Dávila - [email protected]
El grupo requiere diseñar servicios REST para una aplicación que maneja información
básica y servicios ofrecidos por bibliotecas dentro de la ciudad de Bogotá. Para ello
debe implementar requerimientos como: crear una biblioteca, obtener todas las
bibliotecas, obtener una biblioteca dado su identificador, cambiar la información de una
biblioteca dado un identificador y borrar una biblioteca dado su identificador.
| Método | Path | Acción | Parámetros | Cuerpo | Retorno |
|---|---|---|---|---|---|
| GET | /bibliotecas | Lista de los registros de Biblioteca(READ) | Colección de registros de Biblioteca | ||
| GET | /bibliotecas/:id | Obtiene los atributos de una instancia de Biblioteca(READ) que tiene identificado id | @PathParam id:Identificador del registro | Atributos de la instancia de Biblioteca | |
| POST | /bibliotecas | Crear una nueva instancia de la entidad Biblioteca(CREATE) | Atributos de la instancia de Biblioteca a crear | Instancia de Biblioteca creada, incluyendo su nuevo ID | |
| PUT | /bibliotecas/:id | Actualiza una instancia de la entidad Biblioteca(UPDATE) | @PathParam id:Identificador del registro | Objeto Json de Biblioteca | Instancia de Biblioteca actualizada |
| DELETE | /bibliotecas/:id | Borra instancia de Biblioteca en el servidor(DELETE) | @PathParam id:Identificador del registro |
La clase BibliotecaResource tendrá entonces los siguientes métodos:
| Método | Descripción |
|---|---|
| List<BibliotecaDTO> getBibliotecas( ) | Retorna la lista de bibliotecas |
| BibliotecaDTO createBiblioteca( ) | Crea una biblioteca con la información suministrada por parámetro |
| BibliotecaDTO getBiblioteca(int id) | Retorna la biblioteca identificada con id |
| BibliotecaDTO updateBiblioteca(int id,BibliotecaDTO b) | Actualiza la información de la biblioteca identificada con id |
| void deleteBiblioteca(int id) | Borra la biblioteca identificada por id |
###Implementación de los Servicios REST para el recurso “Usuario” de la aplicación Biblioteca del grupo de trabajo “G5”
USUARIO
| Método | URI | Acción | Parámetros | Cuerpo | Retorno |
|---|---|---|---|---|---|
| GET | /usuario | Obtener la informacion de los usuarios | Lista de usuarios | ||
| GET | /usuario/:nombre | Obtener la informacion del usuario | @PathParam nombre: nombre del usuario | Atributos del usuario | |
| POST | /usuario/:nombre | Crear un nuevo usuario | Atributos del nuevo usuario | Instancia del usuario creado | |
| PUT | /usuario/:nombre | Modifica la informacion del usuario (UPDATE) | @PathParam nombre: nombre del usuario | Atributos del usuario despues de su modificacion | |
| DELETE | /usuario/:nombre | Borrar la informacion del usuario (DELETE) | @PathParam nombre: nombre del usuario |
###Implementación de los Servicios REST para el recurso “Reserva” de la aplicación Biblioteca del grupo de trabajo “G5”
RESERVA ** Implementado por David Patiño -d.patino12**
| Método | URI | Acción | Parámetros | Cuerpo | Retorno |
|---|---|---|---|---|---|
| GET | /Reservas | Obtener la informacion de todas las reservas | Lista de las reservas | ||
| GET | /Reservas/:idReserva | Obtener la informacion de la reserva | @PathParam idReserva: id de la reserva | Atributos de la reserva | |
| POST | /Reservas | Crear una nueva reserva | Atributos de la nueva reserva | Instancia de la nueva reserva | |
| PUT | /Reservas/:idReserva | Modifica la informacion la reserva (UPDATE) | @PathParam idReserva: id de la reserva | Atributos de la reserva que se modifico | |
| DELETE | /Reservas/:idReserva | Borrar la informacion de la reserva (DELETE) | @PathParam idReserva: id de la reserva |
###Implementación de los Servicios REST para el recurso “Videos” de la aplicación Biblioteca del grupo de trabajo “G5” VIDEO** Implementado por Carlos Gonzalez-ce.gonzalez13**
El grupo requiere manejar mediante servicios REST los videos que cada biblioteca posee
y las distintas operaciones que la biblioteca debe tener con estos. Para ello,
se deben implementar requerimientos como: obtener un video específico de la biblioteca
dado su id, crear una nueva instancia de video (asignándole un id y sus atributos),
obtener todos los videos disponibles en la biblioteca, cambiar información de algún
de algún video dado su id y remover algún video de la biblioteca, dado su id.
| Método | Path | Acción | Parámetros | Cuerpo | Retorno |
|---|---|---|---|---|---|
| GET | /videos | Lista de los registros de Videos(READ) | Colección de registros de Videos | ||
| GET | /videos/:id | Obtiene los atributos de una instancia de Videos(READ) que tiene identificado id | @PathParam id:Identificador del registro | Atributos de la instancia de Videos | |
| POST | /videos | Crear una nueva instancia de la entidad Videos(CREATE) | Atributos de la instancia de Videos a crear | Instancia de Videos creada, incluyendo su nuevo ID | |
| PUT | /videos/:id | Actualiza una instancia de la entidad Videos(UPDATE) | @PathParam id:Identificador del registro | Objeto Json de Videos | Instancia de Videos actualizada |
| DELETE | /bibliotecas/:id | Borra instancia de Videos en el servidor(DELETE) | @PathParam id:Identificador del registro |
La clase VideosResource tendrá entonces los siguientes métodos:
| Método | Descripción |
|---|---|
| List<VideosDTO> getVideos( ) | Retorna la lista de videos |
| VideosDTO createVideo( ) | Crea un video nuevo con la información suministrada por parámetro. Retorna el nuevo video. |
| VideosDTO getVideo(int id) | Retorna el video identificado con id |
| VideosDTO updateVideo(int id,VideosDTO b) | Actualiza la información del video identificado con id, retorna el video actualizado. |
| void deleteVideo (int id) | Borra el video identificado por id |
###Implementación de los Servicios REST para el recurso “Libros” de la aplicación Biblioteca del grupo de trabajo “G5”
LIBRO
Implementado por Santiago Rojas Herrera - [email protected]
| Método | Path | Acción | Parámetros | Cuerpo | Retorno |
|---|---|---|---|---|---|
| GET | /libros | Despliega una lista de los libros en la base de datos(READ) | Colección de registros de libros | ||
| GET | /libros/:id | Obtiene los atributos de una instancia de libros(READ) que tiene identificacion id | @PathParam id:Identificador del registro | Atributos de la instancia del libro | |
| POST | /libros | Crea una nueva instancia del recurso libros(CREATE) | Atributos de la instancia de libros a crear | Instancia de libros creada | |
| PUT | /libros/:id | Actualiza una instancia de la entidad libros(UPDATE) | @PathParam id:Identificador del registro | Objeto Json de libros | Instancia de libros actualizada |
| DELETE | /libros/:id | Borra instancia de libros en el servidor(DELETE) | @PathParam id:Identificador del registro |
Métodos clase LibroResource:
| Método | Descripción |
|---|---|
| List<libroDTO> getlibros() | Retorna la lista de libros |
| LibroDTO createLibro() | Crea un video nuevo con la información suministrada por parámetro. Retorna el nuevo video. |
| LibroDTO getLibro(int id) | Retorna el video identificado con id |
| LibroDTO updateLibro(int id,librosDTO libro) | Cambia los atributos del libro con id |
| void deleteLibro(int id) | Elimina el libro con id |
###Implementación de los Servicios REST para el recurso “Blogs” de la aplicación Biblioteca del grupo de trabajo “G5”
LIBRO
Implementado por Juan Sebastian Prieto - [email protected]
| Método | Path | Acción | Parámetros | Cuerpo | Retorno |
|---|---|---|---|---|---|
| GET | /blogs | Despliega una lista de los blogs en la base de datos(READ) | Colección de registros de blogs | ||
| GET | /blogs/:id | Obtiene los atributos de una instancia de blogs(READ) que tiene identificacion id | @PathParam id:Identificador del registro | Atributos de la instancia del blog | |
| POST | /blogs | Crea una nueva instancia del recurso blogs(CREATE) | Atributos de la instancia de blogs a crear | Instancia de blogs creada | |
| PUT | /blogs/:id | Actualiza una instancia de la entidad blogs(UPDATE) | @PathParam id:Identificador del registro | Objeto Json de blogs | Instancia de blogs actualizada |