Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

✨ Adiciona configurações web para segurança, CORS e OpenAPI #12

Merged
merged 2 commits into from
Apr 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
package diegosneves.github.cleanarchitecture.infrastructure.api.config.web;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.cors.CorsConfiguration;
import org.springframework.web.cors.UrlBasedCorsConfigurationSource;
import org.springframework.web.filter.CorsFilter;

/**
* Classe de configuração para habilitar o compartilhamento de recursos de origem cruzada (CORS).
* <p>
* Esta classe fornece um bean para {@link CorsFilter}, que é usado para interceptar e
* tratar requisições CORS. Ela permite requisições de qualquer origem, com quaisquer cabeçalhos e
* qualquer método.
* <p>
* A configuração CORS é ajustada para permitir credenciais, o que significa que cookies e
* tokens de autenticação podem ser incluídos nas requisições.
* <p>
* Exemplo de uso:
*
* <pre>
* {@code
* @Configuration
* public class AppConfig {
*
* @Bean
* public CorsFilter corsFilter() {
* UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
* CorsConfiguration config = new CorsConfiguration();
* config.setAllowCredentials(true);
* config.addAllowedOrigin("*");
* config.addAllowedHeader("*");
* config.addAllowedMethod("*");
* source.registerCorsConfiguration("/**", config);
* return new CorsFilter(source);
* }
*
* }
* }
* </pre>
*
* @author diegosneves
*/
@Configuration
public class CorsConfig {

/**
* Este método inicializa e define as regras para o filtro CORS (Cross Origin Resource Sharing).
* Primeiramente, é criada uma instância da classe `{@link UrlBasedCorsConfigurationSource}`, responsável por fornecer
* um objeto de configuração baseado em URL para o filtro CORS.
* <p>
* Em seguida, é criada uma instância da classe `{@link CorsConfiguration}`, onde as regras CORS são configuradas.
* A configuração específica permite qualquer origem, cabeçalho e método HTTP.
* <p>
* No final, este objeto de configuração é registrado (o caminho é definido usando o padrão `/**`)
* com o objeto `{@link UrlBasedCorsConfigurationSource}`.
* <p>
* Por fim, o método retorna uma nova instância de `{@link CorsFilter}` inicializada com o objeto `{@link UrlBasedCorsConfigurationSource}`.
*
* @return Um objeto `{@link CorsFilter}` inicializado com as regras CORS configuradas.
* <p>
* Nota: Esta documentação assume que você já incluiu as dependências necessárias e que sua API foi corretamente configurado para usar Spring Framework.
*/
@Bean
public CorsFilter corsFilter() {
UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
CorsConfiguration config = new CorsConfiguration();
config.setAllowCredentials(true);
config.addAllowedOrigin("*"); // Permitir solicitações de qualquer origem
config.addAllowedHeader("*"); // Permitir qualquer cabeçalho
config.addAllowedMethod("*"); // Permitir qualquer método (GET, POST, etc.)
source.registerCorsConfiguration("/**", config);
return new CorsFilter(source);
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
package diegosneves.github.cleanarchitecture.infrastructure.api.config.web;

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Contact;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.tags.Tag;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import java.util.List;

/**
* Classe de configuração para a documentação da API aberta ({@link OpenAPI}).
* <p>
* Esta classe configura as informações detalhadas e as tags que são exibidas na documentação do <b>Swagger/OpenAPI</b>.
* <p>
* Isso inclui meta-informações como a versão da API, título, descrição, detalhes de contato e tags usadas para agrupar endpoints relacionados.
* <p>
*
* @author diegosneves
*/
@Configuration
public class OpenApiConfig {

/**
* Retorna uma instância personalizada do {@link OpenAPI}.
* <p>
* Este método configura informações detalhadas e tags que serão exibidas na documentação Swagger/OpenAPI.
*
* @return a instância personalizada do {@link OpenAPI}
*/
@Bean
public OpenAPI customOpenAPI() {
return new OpenAPI()
.info(getInfo())
.tags(getTags());
}


/**
* Busca informações sobre a API.
*
* @return Uma instância da classe {@link Info} contendo versão, título, descrição e detalhes de contato
*/
private Info getInfo() {
return new Info()
.version("v1.0.0")
.title("Clean Architecture")
.description("API representativa de um design Arquitetural")
.contact(new Contact().email("[email protected]").url("https://github.com/diegosneves/clean-architecture").name("Diego Neves"));
}

/**
* Recupera a lista de Etiquetas ({@link Tag Tags}).
*
* @return Uma lista de Etiquetas ({@link Tag Tags}), cada uma contendo um nome e uma descrição que detalham a
* finalidade da respectiva Etiqueta.
*/
private List<Tag> getTags() {
return List.of(new Tag().name("Customer").description("Funcionalidades direcionadas para os Clientes"));
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
package diegosneves.github.cleanarchitecture.infrastructure.api.config.web;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.config.annotation.web.configurers.AbstractHttpConfigurer;
import org.springframework.security.web.SecurityFilterChain;

/**
* A classe {@link WebSecurityConfig} tem a responsabilidade de definir as configurações de segurança web desta aplicação.
*
* @author diegosneves
*/
@Configuration
@EnableWebSecurity
public class WebSecurityConfig {

/**
* Cria uma cadeia de filtros de segurança ({@link SecurityFilterChain}) para a instância {@link HttpSecurity} fornecida.
*
* @param http a instância de {@link HttpSecurity} que será configurada
* @return a cadeia de filtros de segurança criada ({@link SecurityFilterChain})
* @throws Exception se ocorrer um erro durante a configuração
*/
@Bean
public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {
http.authorizeHttpRequests(authorizationManagerRequestMatcherRegistry -> authorizationManagerRequestMatcherRegistry.anyRequest().permitAll())
.csrf(AbstractHttpConfigurer::disable);
return http.build();
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
package diegosneves.github.cleanarchitecture.infrastructure.api.controllers;

/**
* Esta interface representa o contrato para o controlador de clientes.
*
* @author diegoneves
*/
public interface CustomerControllerContract {

//TODO - Implementar...

}
Loading