Documentación de los servicios REST con Swagger

Clase 30 de 38 • Curso de Hibernate y Java Spring 2018

Clase anteriorSiguiente clase

Lázaro Bucio Marín

student•

Voy Muy Bien.!!!
Animo 😛

César Espitia

student•

Acá dejo unas imagenes del funcionamiento de swagger en mi proyecto, así como los resultados en la base de datos: Registros en la base de datos

Página principal swagger

Consumo del método findAll() por GET

Respuesta del método findAll() por GET

Luis Fernando Pedroza Taborda

student•

Uff Kashirou001, le quedo brutal, gracias por compartirnos tus resultados.

Edwin Donato Dominguez Oliva

student•

Muy buena clase, documentar el API es importante para el mantenimiento de nuestras aplicaciones web.

Pablo David Vallejos

student•

los codigos 200 de http ! 200 OK Respuesta estándar para solicitudes HTTP exitosas. La respuesta real dependerá del método de solicitud utilizado. En una solicitud GET, la respuesta contendrá una entidad correspondiente al recurso solicitado. En una solicitud POST, la respuesta contendrá una entidad que describa o contenga el resultado de la acción. 201 Creado La solicitud se ha cumplido, lo que resulta en la creación de un nuevo recurso. 202 aceptado La solicitud ha sido aceptada para su procesamiento, pero el procesamiento no se ha completado. La solicitud podría o no ser procesada eventualmente, y puede ser rechazada cuando ocurra el procesamiento. 203 Información no autorizada (desde HTTP / 1.1) El servidor es un proxy transformador (por ejemplo, un acelerador web) que recibió un 200 OK de su origen, pero está devolviendo una versión modificada de la respuesta del origen. 204 Sin contenido El servidor procesó con éxito la solicitud y no está devolviendo ningún contenido. 205 Restablecer contenido El servidor procesó con éxito la solicitud, pero no devuelve ningún contenido. A diferencia de una respuesta 204, esta respuesta requiere que el solicitante restablezca la vista del documento. 206 Contenido parcial (RFC 7233) El servidor está entregando solo una parte del recurso (servicio de bytes) debido a un encabezado de rango enviado por el cliente. Los clientes HTTP utilizan el encabezado de rango para permitir la reanudación de descargas interrumpidas o dividir una descarga en múltiples flujos simultáneos. 207 Multi-Status (WebDAV; RFC 4918) El cuerpo del mensaje que sigue es, por defecto, un mensaje XML y puede contener una cantidad de códigos de respuesta separados, dependiendo de cuántas solicitudes se hayan realizado. 208 ya informado (WebDAV; RFC 5842) Los miembros de un enlace DAV ya se han enumerado en una parte anterior de la respuesta (multiestatus), y no se vuelven a incluir. 226 IM utilizado (RFC 3229) El servidor ha completado una solicitud para el recurso, y la respuesta es una representación del resultado de una o más manipulaciones de instancia aplicadas a la instancia actual.

Rubén Zamora González

student•

Usando intelliJ me estaba dando el siguiente error, desde que implementé swagger

Failed to execute goal org.springframework.boot:spring-boot-maven-plugin:2.2.5.RELEASE:run (default-cli) on project e-reservation: Application finished with exit code: 1

Como no podía trazar el error, usé EReservationApplication del Edit Configuration... que ese si te da una traza de los archivos que se van ejecutando.

Sigue siendo dificil de ver, pero detecté que el problema estaba en una identación mal puesta en mi application.yml

MAL

spring:
  datasource:
    url: jdbc:postgresql://localhost:5432/postgres
    username: postgres
    password: platzi
    driver-class-name: org.postgresql.Driver
  jpa:
    hibernate:
      ddl-auto: create-drop
     generate-ddl: true
    show-sql: true

BIEN "El error estaba, en que faltaba un espacio en generate-ddl: true"

spring:
  datasource:
    url: jdbc:postgresql://localhost:5432/postgres
    username: postgres
    password: platzi
    driver-class-name: org.postgresql.Driver
  jpa:
    hibernate:
      ddl-auto: create-drop
      generate-ddl: true
    show-sql: true

Lo comparto porque me tuvo bastante tiempo atascado esta tontería

Elvis Claudio Huacachi Caldas

student•

Yo lo tengo identado de esta forma y sin problemas.

FABIAN CHARA

student•

Usando el método createReserva obtuve un problema: infinite loop. Lo anterior es en parte debido a las relaciones definidas en el modelo. Para resolverlo en la clase Reserva se agrega la anotación @JsonManagedReference, quedando así:

...
@ManyToOne
@JoinColumn(name = "idCli")
@JsonManagedReference
private Cliente cliente;
...

Del lado de la clase cliente quedaría así:

...
@OneToMany(mappedBy = "cliente")
@JsonBackReference
private Set<Reserva> reservas;
...

Wilber Luna Jiménez

student•

Alguien sabe como crear un cliente usasndo la interfaz de swagger, intenté varias veces pero me pone este error

{
  "timestamp": "2020-02-10T15:52:03.433+0000",
  "status": 403,
  "error": "Forbidden",
  "message": "Forbidden",
  "path": "/api/cliente"
}```

Antonio Jose Dos Ramos Lugo

student•

403 significa que no tienes permisos, tienes por casualidad spring security configurado?

Juan Camilo Sarmiento Reyes

student•

Tuve problemas al mostrar el swagger, aunque las dependencias no me mostraban un error y la configuración parecía estar bien.

Encontré la solución en esta respuesta de Stackoverflow: https://stackoverflow.com/a/64995810/8172429

Yossijaki Jorge Astilleros Chávez

student•

Excelente implementación

Eliana Huamani

student•

Recomiendo que con un cliente Rest testeen cada servicio expuesto.

Gabriel Eduardo

student•

En el caso del @GetMapping el código para el caso OK, no deberia ser 200 en lugar de 201? o estoy confundiendo las cosas?

Pablo David Vallejos

student•

200 OK Respuesta estándar para solicitudes HTTP exitosas. La respuesta real dependerá del método de solicitud utilizado. En una solicitud GET, la respuesta contendrá una entidad correspondiente al recurso solicitado. En una solicitud POST, la respuesta contendrá una entidad que describa o contenga el resultado de la acción. 201 Creado La solicitud se ha cumplido, lo que resulta en la creación de un nuevo recurso. 202 aceptado La solicitud ha sido aceptada para su procesamiento, pero el procesamiento no se ha completado. La solicitud podría o no ser procesada eventualmente, y puede ser rechazada cuando ocurra el procesamiento. 203 Información no autorizada (desde HTTP / 1.1) El servidor es un proxy transformador (por ejemplo, un acelerador web) que recibió un 200 OK de su origen, pero está devolviendo una versión modificada de la respuesta del origen. 204 Sin contenido El servidor procesó con éxito la solicitud y no está devolviendo ningún contenido. 205 Restablecer contenido El servidor procesó con éxito la solicitud, pero no devuelve ningún contenido. A diferencia de una respuesta 204, esta respuesta requiere que el solicitante restablezca la vista del documento. 206 Contenido parcial (RFC 7233) El servidor está entregando solo una parte del recurso (servicio de bytes) debido a un encabezado de rango enviado por el cliente. Los clientes HTTP utilizan el encabezado de rango para permitir la reanudación de descargas interrumpidas o dividir una descarga en múltiples flujos simultáneos. 207 Multi-Status (WebDAV; RFC 4918) El cuerpo del mensaje que sigue es, por defecto, un mensaje XML y puede contener una cantidad de códigos de respuesta separados, dependiendo de cuántas solicitudes se hayan realizado. 208 ya informado (WebDAV; RFC 5842) Los miembros de un enlace DAV ya se han enumerado en una parte anterior de la respuesta (multiestatus), y no se vuelven a incluir. 226 IM utilizado (RFC 3229) El servidor ha completado una solicitud para el recurso, y la respuesta es una representación del resultado de una o más manipulaciones de instancia aplicadas a la instancia actual.

Mateo Villanueva

student•

org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'reservaService' defined in file [C:\Users\Mateo\Documents\Programacion web full stack\demo\target\classes\com\example\demo\Deal\service\reservaService.class]: Unsatisfied dependency expressed through constructor parameter 0; nested exception is org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'reservaRepository': Invocation of init method failed; nested exception is java.lang.IllegalArgumentException: Failed to create query for method public abstract com.example.demo.Model.Reserva com.example.demo.Deal.Repository.reservaRepository.findByCodigoRes(java.lang.String)! No property codigoRes found for type Reserva!

Hola buen día a todos me sale este error al ejecutar, me ayudarían?

David Calle

student•

la clase Reserva no tiene ningún atributo con nombre codigoRes. Si mandas un screenshot de la entidad te puedo ayudar un poco más

Joan Federico Marin Ruiz

student•

buenas no me sale para importar el ApiResponse, solo me dejo el ApiResponses, que podria ser?

@ApiResponses(value = {@ApiResponse(code = 201, message = &quot;Cliente creado correctamente&quot;),
			@ApiResponse(code = 400, message = &quot;Solicitud InvÃ¡lida&quot;) })```

William Alexander Hernandez Leiva

student•

import io.swagger.annotations.ApiResponse;

Revisa si tienes importada esta libreria en tu clase.

William Alexander Hernandez Leiva

student•

Tambien puedes probar actualizando tu proyecto y revisar en el pom tu dependencia de Swagger

Fernando Ortega

student•

SU ayuda por favor, al abrir en el navegador me aparece lo siguiente: Whitelabel Error Page This application has no explicit mapping for /error, so you are seeing this as a fallback.

Fri Apr 09 15:18:55 ECT 2021 There was an unexpected error (type=Not Found, status=404).

David Felipe Garay Pérez

student•

eso es porque no tienes un index, o un lugar donde vaya tu aplicación pro defecto cuando no se asigna un la Path en el navegador, puedes crear un @GetMapping("/") que retorne un string "Hola mundo", ya con eso no te saldría esa pagina.

@RestController
public class IndexController {

	@GetMapping("/")
	public String defaultPath() {
		return "Hola mundo lindo ;)"; 
	}
}

Leonel Lopez

student•

Me aparece el siguiente mensaje "Unable to infer base url. This is common when using dynamic servlet registration or when the API is behind an API Gateway. The base url is the root of where all the swagger resources are served. For e.g. if the api is available at http://example.org/api/v2/api-docs then the base url is http://example.org/api/. Please enter the location manually: " cuando entro en http://localhost:8080/swagger-ui.html

Erik Elyager

student•

En esta respuesta de stackoverflow recomiendan agregar una configuración de seguridad para saltarse ciertas URLs (no lo recomiendo para producción)

private static final String[] AUTH_WHITELIST = {
        "/swagger-resources/**",
        "/swagger-ui.html",
        "/v2/api-docs",
        "/webjars/**"
};

@Override
public void configure(WebSecurity web) throws Exception {
    web.ignoring().antMatchers(AUTH_WHITELIST);
}

Otra respuesta recomienda añadir el annotation @EnableSwagger2.

Luis Guilermo Figueroa Hernandez

student•

Tengo una duda, tenia un error con estos dos métodos, y lo solucione cambiando una de las anotaciones @PostMapping por @PutMapping, ¿Cual es la diferencia entre estas anotaciones, y porque generan conflicto?.

@PostMapping
	@ApiOperation(value = "Crear Cliente", notes = "Servicio para crear un nuevo cliente")
	@ApiResponses(value = { @ApiResponse(code = 201, message = "Cliente creado Correctamente"),
			@ApiResponse(code = 400, message = "Solicitud Inválida") })
	public ResponseEntity<Cliente> createCliente(@RequestBody ClienteVO clienteVO) {
		Cliente cliente = new Cliente();
		cliente.setNombreCliente(clienteVO.getNombreCliente());
		cliente.setApellidoCliente(clienteVO.getApellidoCliente());
		cliente.setDireccionCliente(clienteVO.getDireccionCliente());
		cliente.setTelefonoCliente(clienteVO.getTelefonoCliente());
		cliente.setEmailCliente(clienteVO.getEmailCliente());
		return new ResponseEntity<>(this.clienteService.create(cliente), HttpStatus.CREATED);
	}
@PutMapping
	@ApiOperation(value = "Actualizar Cliente", notes = "Servicio para actualizar un cliente")
	@ApiResponses(value = { @ApiResponse(code = 201, message = "Cliente actualizado Correctamente"),
			@ApiResponse(code = 404, message = "Cliente no encontrado") })
	public ResponseEntity<Cliente> updateCliente(@PathVariable("identificacion") String identificacion,
			ClienteVO clienteVO) {
		Cliente cliente = this.clienteService.findByIdCliente(identificacion);

		if (cliente == null) {

			return new ResponseEntity<Cliente>(HttpStatus.NOT_FOUND);
		} else {

			cliente.setNombreCliente(clienteVO.getNombreCliente());
			cliente.setApellidoCliente(clienteVO.getApellidoCliente());
			cliente.setDireccionCliente(clienteVO.getDireccionCliente());
			cliente.setTelefonoCliente(clienteVO.getTelefonoCliente());
			cliente.setEmailCliente(clienteVO.getEmailCliente());
		}
		return new ResponseEntity<>(this.clienteService.update(cliente), HttpStatus.OK);
	}

Daniel G. Fernández G.

student•

Si tienen un error de Swagger al compilar, prueben cambiando la versión de spring-boot en el archivo pom.xml a 2.5.8 para resolverlo.

<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.5.8</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>

JESUS ALMIRCAR CASTELLANOS

student•

🚑️Ir a repositorio
🚑️Ir a repositorio

JESUS ALMIRCAR CASTELLANOS

student•

🔥Ir a repositorio
🔥Ir a repositorio

Carlos Riojas De Los Santos

student•

Para los que EN EL EDITOR(no en compilación) les marque error "the method "getNombreCli()" is undefined,junto con los demas metodos, RELAJENSE, compilen y vean.