https://github.com/iruzhnikov/spring-cors-properties
CORS configuration from properties file
https://github.com/iruzhnikov/spring-cors-properties
java spring spring-boot spring-security
Last synced: 4 months ago
JSON representation
CORS configuration from properties file
- Host: GitHub
- URL: https://github.com/iruzhnikov/spring-cors-properties
- Owner: IRuzhnikov
- License: apache-2.0
- Created: 2022-03-15T07:14:39.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-09-20T04:23:37.000Z (almost 3 years ago)
- Last Synced: 2025-04-02T09:14:43.889Z (about 1 year ago)
- Topics: java, spring, spring-boot, spring-security
- Language: Java
- Homepage:
- Size: 211 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Description
This library enables the CORS configuration in application property
files such as application.properties / application.yml / cors.yml
In general. no coding is required to configure CORS for different
environments of your application. All you need to do is
1. add the feature to your project changing maven / gradle / other build tool config
2. enable the feature in project property file
3. configure the CORS in the same or separate property file, that's up to you to decide
# How to add the feature to Spring Boot
To enable the feature, please add the dependency to your project (navigate to this links):
> [](https://search.maven.org/search?q=g:%22io.github.iruzhnikov%22%20AND%20a:%22spring-webmvc-cors-properties-autoconfigure%22)
> group: _io.github.iruzhnikov_
> name: _spring-webmvc-cors-properties-autoconfigure_
> [](https://search.maven.org/search?q=g:%22io.github.iruzhnikov%22%20AND%20a:%22spring-webflux-cors-properties-autoconfigure%22)
> group: _io.github.iruzhnikov_
> name: _spring-webflux-cors-properties-autoconfigure_
# To enable the feature in Spring Boot project
Add this property to `application.properties` file for adding reading configuration from different file
`application.properties` file content:
```yml
spring.config.import: optional:classpath:cors.yml
```
Configure the CORS rules in `cors.yml` properties file
`cors.yml` file content:
```yml
spring:
web:
cors:
enabled: true
mappings: #spring.web.cors.mappings..:
anyName: #just any name, just for grouping properties under the same path pattern (not used in internal logic)
paths: #ant style path pattern, ATTENTION! not ordered, /** pattern override all other pattern
- /path/to/api
- /path/to/api/**
#allowed-origins: "*"
allowed-methods: GET #Enable override all defaults! If disabled: a lot more from all the controller methods included from the path pattern matches
#allowed-headers: "*"
#exposed-headers: ('*' - not-supported)
#allow-credentials: true
allowed-origin-patterns: .*
#max-age: PT30M
```
The 'anyName' in configuration lets you configure the different groups, e.g. 'path /api' and 'path /api/admin' may
have CORS configurations. To make the configurations different, please different sections, e.g. 'anyName: api' and
'anyName: apiAdmin'.
Actually, that's all you need to do basic configuration. The further configs are to let you make tiny
configurations.
> 
> To specify details of CORS configuration you may use a separate file _cors.yml_ (of course you may use default
> _application.properties_ file).
> [more details about `spring.config.import` in Spring](https://docs.spring.io/spring-cloud-config/docs/current/reference/html/#config-data-import)
> 
> Don't use this library for CORS configuration for `Spring Actuator`,
> because this library has self specific config (props name like of _management.*_)
> [more details in Spring](https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html#actuator.endpoints.cors)
> 
> For application.yml files that contains several 'spring.profiles', please use property file annotation (one line)
> for `spring.web.cors.enabled`, otherwise spring boot ignores the config line.
> [more details in stackoverflow](https://stackoverflow.com/a/35400025)
### Autoconfigure for _allowed-methods_ (GET, POST etc.) by _path_ patterns
If you like to have the automatic discovery of the _allowed-methods_ in your CORS configuration, please
remove _@EnableWebMvc_ in your code.
> 
> if you extended corresponding class:
> ```java
> //for MVC
> import org.springframework.webmvc.servlet.config.annotation.WebMvcConfigurationSupport;
> //for FLUX
> import org.springframework.web.reactive.config.DelegatingWebFluxConfiguration;
> ```
>
> please change extended class to next class or open it for learning how to it works
> (I mean createRequestMappingHandlerMapping
> function)
>
> ```java
> //for MVC
> import io.github.iruzhnikov.webmvc.servlet.CorsPropWebMvcConfigurationSupport;
> //for FLUX
> import io.github.iruzhnikov.webflux.servlet.CorsPropWebFluxConfigurationSupport;
> ```
# To enable the feature in Spring Framework
You must register property apply bean
```java
//for MVC
import io.github.iruzhnikov.webmvc.servlet.SpringMvcCorsConfigurer;
//for FLUX
import io.github.iruzhnikov.webflux.servlet.SpringFluxCorsConfigurer;
```
and you should register autoconfiguration for _allowed-methods_ (not required)
```java
//for MVC
import io.github.iruzhnikov.webmvc.servlet.CorsEndpointHandlerMapping;
//for FLUX
import io.github.iruzhnikov.webflux.servlet.CorsEndpointHandlerMapping;
```