Skip to content
This repository has been archived by the owner on Mar 21, 2024. It is now read-only.

Commit

Permalink
Merge pull request #9 from UNIR-WG/feature/loans_api
Browse files Browse the repository at this point in the history 
Adding swagger docs to LoanController
  • Loading branch information
@devmariodiaz
devmariodiaz authored Jan 31, 2024
2 parents 82aa832 + 7ab9fa9 commit 0f485f7
Showing 1 changed file with 86 additions and 8 deletions.
94 changes: 86 additions & 8 deletions .../net/unir/missi/desarrollowebfullstack/bookabook/operador/controller/LoansController.java
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,18 @@
package net.unir.missi.desarrollowebfullstack.bookabook.operador.controller;

import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import net.unir.missi.desarrollowebfullstack.bookabook.operador.exceptions.BadParametersException;
import net.unir.missi.desarrollowebfullstack.bookabook.operador.exceptions.EntityInvalidOperationException;
import net.unir.missi.desarrollowebfullstack.bookabook.operador.exceptions.EntityNotFoundException;
import net.unir.missi.desarrollowebfullstack.bookabook.operador.model.api.LoanRequest;
import net.unir.missi.desarrollowebfullstack.bookabook.operador.model.api.LoanResponse;
import net.unir.missi.desarrollowebfullstack.bookabook.operador.model.sql.Loan;
import net.unir.missi.desarrollowebfullstack.bookabook.operador.service.LoanService;

import org.springframework.beans.factory.annotation.Autowired;
Expand All @@ -27,20 +32,27 @@ public class LoansController {
private final LoanService service;

@GetMapping("/loans")
@Operation(
operationId = "Obtener préstamos",
description = "Operacion de lectura",
summary = "Se devuelve una lista de todos los préstamos almacenados en la base de datos.")
@ApiResponse(
responseCode = "200",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Loan.class)))
public ResponseEntity<List<LoanResponse>> getLoans(
@Parameter(name="bookId", example = "")
@Parameter(name="bookId", description = "Id del Libro préstado")
@RequestParam(required = false) Long bookId,
@Parameter(name="clientId", example = "")
@Parameter(name="clientId", description = "Id del Cliente al que se le realizó el préstamo")
@RequestParam(required = false) Long clientId,
@Parameter(name="loanDate", example = "")
@Parameter(name="loanDate", description = "Fecha de registro del préstamo")
@RequestParam(required = false) LocalDate loanDate,
@Parameter(name="returnDate", example = "")
@Parameter(name="returnDate", description = "Fecha en que el libro fue devuelto")
@RequestParam(required = false)LocalDate returnDate,
@Parameter(name="dueDate", example = "")
@Parameter(name="dueDate", description = "Fecha de vencimiento del préstamo")
@RequestParam(required = false)LocalDate dueDate,
@Parameter(name="isReturned", example = "")
@Parameter(name="isReturned", description = "Indica si el libro ha sido devuelto")
@RequestParam(required = false)Boolean isReturned,
@Parameter(name="renewalCount", example = "")
@Parameter(name="renewalCount", description = "Cantidad de renovaciones del préstamo")
@RequestParam(required = false)Integer renewalCount
) {

Expand All @@ -64,6 +76,17 @@ public ResponseEntity<List<LoanResponse>> getLoans(
}

@GetMapping("/loans/{id}")
@Operation(
operationId = "Obtener un préstamo",
description = "Operacion de lectura",
summary = "Se devuelve un préstamo a partir de su identificador.")
@ApiResponse(
responseCode = "200",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Loan.class)))
@ApiResponse(
responseCode = "404",
content = @Content(mediaType = "application/json", schema = @Schema()),
description = "No se ha encontrado el préstamo con el identificador indicado.")
public ResponseEntity<LoanResponse> getLoan(@PathVariable String id) {
try
{
Expand All @@ -85,6 +108,25 @@ public ResponseEntity<LoanResponse> getLoan(@PathVariable String id) {
}

@PostMapping("/loans")
@Operation(
operationId = "Crear un préstamo",
description = "Operacion de escritura",
summary = "Se crea un préstamo a partir de sus datos.",
requestBody = @io.swagger.v3.oas.annotations.parameters.RequestBody(
description = "Datos del préstamo a crear.",
required = true,
content = @Content(mediaType = "application/json", schema = @Schema(implementation = LoanRequest.class))))
@ApiResponse(
responseCode = "201",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = LoanResponse.class)))
@ApiResponse(
responseCode = "400",
content = @Content(mediaType = "application/json", schema = @Schema()),
description = "Datos incorrectos introducidos.")
@ApiResponse(
responseCode = "404",
content = @Content(mediaType = "application/json", schema = @Schema()),
description = "Id del Libro O Id del Cliente no existen.")
public ResponseEntity<LoanResponse> addLoan(@RequestBody LoanRequest loanRequest) {
try
{
Expand All @@ -101,7 +143,6 @@ public ResponseEntity<LoanResponse> addLoan(@RequestBody LoanRequest loanRequest
}
catch (BadParametersException e)
{
Logger.getGlobal().warning("Bad Parameters");
return ResponseEntity.badRequest().build();
}
catch(EntityInvalidOperationException e) {
Expand All @@ -115,6 +156,17 @@ public ResponseEntity<LoanResponse> addLoan(@RequestBody LoanRequest loanRequest
}

@DeleteMapping("/loans/{id}")
@Operation(
operationId = "Eliminar un préstamo",
description = "Operacion de escritura",
summary = "Se elimina un préstamo a partir de su identificador.")
@ApiResponse(
responseCode = "200",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = LoanResponse.class)))
@ApiResponse(
responseCode = "404",
content = @Content(mediaType = "application/json", schema = @Schema()),
description = "No se ha encontrado el préstamo con el identificador indicado.")
public ResponseEntity<LoanResponse> deleteLoan(@PathVariable String id) {
try
{
Expand All @@ -131,6 +183,21 @@ public ResponseEntity<LoanResponse> deleteLoan(@PathVariable String id) {
}

@PatchMapping("/loans/{id}")
@Operation(
operationId = "Modificar parcialmente un préstamo",
description = "RFC 7386. Operacion de escritura",
summary = "RFC 7386. Se modifica parcialmente un préstamo.",
requestBody = @io.swagger.v3.oas.annotations.parameters.RequestBody(
description = "Datos del préstamo a modificar.",
required = true,
content = @Content(mediaType = "application/merge-patch+json", schema = @Schema(implementation = LoanRequest.class))))
@ApiResponse(
responseCode = "200",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = LoanResponse.class)))
@ApiResponse(
responseCode = "400",
content = @Content(mediaType = "application/json", schema = @Schema()),
description = "Datos incorrectos introducidos.")
public ResponseEntity<LoanResponse> patchLoan(@RequestBody LoanRequest loanRequest, @PathVariable String id) {
try
{
Expand All @@ -157,6 +224,17 @@ public ResponseEntity<LoanResponse> patchLoan(@RequestBody LoanRequest loanReque
}

@GetMapping("/clients/{clientId}/loans")
@Operation(
operationId = "Obtener los préstamos de un cliente.",
description = "Operacion de lectura",
summary = "Se devuelve una lista de préstamos relacionados a un cliente.")
@ApiResponse(
responseCode = "200",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = LoanResponse.class)))
@ApiResponse(
responseCode = "404",
content = @Content(mediaType = "application/json", schema = @Schema()),
description = "No se han encontrado préstamos con el identificador de clienteindicado.")
public ResponseEntity<List<LoanResponse>> getLoanByClientId(@PathVariable String clientId) {
try
{
Expand Down

0 comments on commit 0f485f7

Please sign in to comment.