Criar uma documentação para o projeto Dsmovie utilizando o Swagger
@Service
public class MovieService {
@Autowired
private MovieRepository repository;
...
@Transactional
public MovieDTO insert(MovieDTO dto) {
Movie entity = dto.toEntity();
entity = repository.save(entity);
return new MovieDTO(entity);
}
@Transactional
public MovieDTO update(Long id, MovieDTO dto) {
Movie entity = repository.getById(id);
updateData(entity, dto);
entity = repository.save(entity);
return new MovieDTO(entity);
}
public void delete(Long id) {
repository.deleteById(id);
}
private void updateData(Movie entity, MovieDTO dto) {
entity.setTitle(dto.getTitle());
entity.setScore(dto.getScore());
entity.setCount(dto.getCount());
entity.setImage(dto.getImage());
}@RestController
@RequestMapping(value = "/movies")
public class MovieController {
@Autowired
private MovieService service;
...
@PostMapping
public ResponseEntity<MovieDTO> insert(@RequestBody MovieDTO dto) {
dto = service.insert(dto);
URI uri = ServletUriComponentsBuilder.fromCurrentRequest().path("/{id}")
.buildAndExpand(dto.getId()).toUri();
return ResponseEntity.created(uri).body(dto);
}
@PutMapping(value = "/{id}")
public ResponseEntity<MovieDTO> update(@PathVariable Long id, @RequestBody MovieDTO dto) {
dto = service.update(id, dto);
return ResponseEntity.ok().body(dto);
}
@DeleteMapping(value = "/{id}")
public ResponseEntity<MovieDTO> delete(@PathVariable Long id) {
service.delete(id);
return ResponseEntity.noContent().build();
}-
Clonar o projeto Spring Boot Dsmovie (* para este projeto vamos usar somente o backend)
-
Ajuste no arquivo pom.xml:
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>3.0.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>- Incluir a classe SwaggerConfig no pacote config:
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.bind.annotation.RestController;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
.paths(PathSelectors.any())
.build();
}
}- Configuração no application.properties para a versao mais recente do Swagger
spring.mvc.pathmatch.matching-strategy=ant-path-matcher
- Anotações nos recursos (controllers)
@Api(tags = "Movie Controller", value = "MovieController", description = "Controller for Movie")
public class MovieController {- Anotações nos endpoints REST
@PostMapping
@ApiOperation(value = "Create a new movie")
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Product inserted successfully"),
@ApiResponse(code = 400, message = "Bad Request")
})
public ResponseEntity<MovieDTO> insert(@RequestBody MovieDTO dto) {@GetMapping(value = "/{id}", produces = MediaType.APPLICATION_JSON_VALUE)
public MovieDTO findById(@PathVariable Long id) {- Anotações model
public class MovieDTO {
@ApiModelProperty(notes = "Database generated movie ID")
private Long id;
@ApiModelProperty(notes = "Movie title")
private String title;- Incluindo metadados swagger
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2).select()
.apis(RequestHandlerSelectors.withClassAnnotation(RestController.class)).paths(PathSelectors.any())
.build()
.apiInfo(metaData());
}
private ApiInfo metaData() {
return new ApiInfoBuilder().title("Dsmovie API")
.description("\"Spring Boot REST API for SDS 8\"").version("1.0.0")
.contact(new Contact("Devsuperior", "https://github.com/devsuperior", "https://www.instagram.com/devsuperior.ig/"))
.build();
}- Ajuste no arquivo pom.xml:
<dependency>
<groupId>javax.validation</groupId>
<artifactId>validation-api</artifactId>
</dependency>
<dependency>
<groupId>org.hibernate.validator</groupId>
<artifactId>hibernate-validator</artifactId>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-bean-validators</artifactId>
<version>2.9.2</version>
</dependency>- Validações básicas
public class MovieDTO {
@NotEmpty(message = "can't be empty")
@Size(min = 3, max = 50, message = "Length must be between 3 and 50")
private String title;
@PositiveOrZero
@Min(value = 0, message = "Score should not be less than 0")
@Max(value = 5, message = "Score should not be greater than 5")
private Double score;
...public class ScoreDTO {
@NotBlank
@Email
private String email;
...public class MovieController {
@PostMapping
public ResponseEntity<MovieDTO> insert(@Valid @RequestBody MovieDTO dto)
@PutMapping(value = "/{id}")
public ResponseEntity<MovieDTO> update(@PathVariable Long id, @Valid @RequestBody MovieDTO dto)
...public class ScoreController {
@PutMapping
public MovieDTO saveScore(@Valid @RequestBody ScoreDTO dto)
...- Importar BeanValidatorPluginsConfiguration no SwaggerConfig
@Configuration
@EnableSwagger2
@Import(BeanValidatorPluginsConfiguration.class)
public class SwaggerConfig {
//...
}- Importante: Caso você tenha algum erro neste passo, sugiro que você altere o seu arquivo pom.xml e modifique a versão da dependência springfox-swagger2 para 2.9.2
-
Copiar o arquivo pom.xml abaixo:
https://gist.github.com/oliveiralex/a65d21b92ce6dd73077ec1c5910361f0
-
Renomear nome da coluna value para score_value na entidade Score
public class Score {
...
@Column(name = "score_value")
private Double value;
}- Modelo de dados User-Role:
@Entity
@Table(name = "tb_role")
public class Role implements GrantedAuthority {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;
private String authority;
public Role() {
}
public Role(Long id, String authority) {
super();
this.id = id;
this.authority = authority;
}
public Long getId() {
return id;
}
public void setId(Long id) {
this.id = id;
}
@Override
public String getAuthority() {
return authority;
}
public void setAuthority(String authority) {
this.authority = authority;
}
}@Entity
@Table(name = "tb_user")
public class User implements UserDetails {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;
@Column(unique = true)
private String email;
private String password;
@ManyToMany(fetch = FetchType.EAGER)
@JoinTable(name = "tb_user_role",
joinColumns = @JoinColumn(name = "user_id"),
inverseJoinColumns = @JoinColumn(name = "role_id"))
private Set<Role> authorities = new HashSet<>();
public User() {
}
public User(Long id, String email, String password) {
this.id = id;
this.email = email;
this.password = password;
}
public Long getId() {
return id;
}
public void setId(Long id) {
this.id = id;
}
public String getEmail() {
return email;
}
public void setEmail(String email) {
this.email = email;
}
public void setPassword(String password) {
this.password = password;
}
@Override
public String getPassword() {
return password;
}
@Override
public String getUsername() {
return email;
}
@Override
public boolean isAccountNonExpired() {
return true;
}
@Override
public boolean isAccountNonLocked() {
return true;
}
@Override
public boolean isCredentialsNonExpired() {
return true;
}
@Override
public boolean isEnabled() {
return true;
}
@Override
public Set<Role> getAuthorities() {
return authorities;
}
}@Service
public class UserService implements UserDetailsService {
@Autowired
private UserRepository repository;
@Override
public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {
User user = repository.findByEmail(username);
if (user == null) {
throw new UsernameNotFoundException("Email not found");
}
return user;
}
}-
Incluir infraestrutura de segurança ao projeto
-
Neste passo, caso você tenha qualquer dúvida, sugiro revisitar no cap. 3 - Validação e Segurança (aula 03-31 Reaproveitando a infraestrutura do DSCatalog), para realizar os seguintes passos:
-
Incluir classes AuthorizationServerConfig, ResourceServerConfig e WebSecurityConfig;
-
Ajustar o application.properties;
-
Ajustar script import.sql (disponível no link abaixo)
https://gist.github.com/oliveiralex/03720209ca79ed318d33bf6f15264d3c
-
-
Testar o projeto
- Configuração para liberar o acesso aos endpoints relativos ao Swagger
@Configuration
@EnableResourceServer
public class ResourceServerConfig extends ResourceServerConfigurerAdapter {
...
private static final String[] SWAGGER = {
"/v2/api-docs",
"/configuration/ui",
"/swagger-resources/**",
"/configuration/security",
"/swagger-ui.html",
"/webjars/**"
};
...
@Override
public void configure(HttpSecurity http) throws Exception {
// H2
if (Arrays.asList(env.getActiveProfiles()).contains("test")) {
http.headers().frameOptions().disable();
}
http.authorizeRequests()
.antMatchers(PUBLIC).permitAll()
.antMatchers(SWAGGER).permitAll()
.antMatchers(HttpMethod.GET, ALL_USERS_GET).permitAll()
.antMatchers(HttpMethod.PUT, ALL_USERS_PUT).permitAll()
.anyRequest().hasAnyRole("ADMIN");
http.cors().configurationSource(corsConfigurationSource());
}
}- Ajustes no SwaggerConfig
@Configuration
@EnableSwagger2
@Import(BeanValidatorPluginsConfiguration.class)
public class SwaggerConfig {
public static final String AUTHORIZATION_HEADER="Authorization";
private ApiKey apiKeys() {
return new ApiKey("JWT", AUTHORIZATION_HEADER, "header");
}
private List<SecurityContext> securityContext() {
return Arrays.asList(SecurityContext.builder().securityReferences(securityReference()).build());
}
private List<SecurityReference> securityReference() {
AuthorizationScope scope = new AuthorizationScope("global", "accessEverything");
return Arrays.asList(new SecurityReference("JWT", new AuthorizationScope[] { scope }));
}
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.securityContexts(securityContext())
.securitySchemes(Arrays.asList(apiKeys()))
.select()
.apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
.paths(PathSelectors.any())
.build()
.apiInfo(metaData());
}
private ApiInfo metaData() {
return new ApiInfoBuilder().title("Dsmovie API")
.description("\"Spring Boot REST API for SDS 8\"").version("1.0.0")
.contact(new Contact("Devsuperior", "https://github.com/devsuperior", "https://www.instagram.com/devsuperior.ig/"))
.build();
}
}- Testar acesso utilizando token JWT