spring-cloud / spring-cloud-gateway

//// DO NOT EDIT THIS FILE. IT WAS GENERATED. Manual changes to this file will be lost when it is generated again. Edit the files in the src/main/asciidoc/ directory instead. //// image::https://github.com/spring-cloud/spring-cloud-gateway/workflows/Build/badge.svg?style=svg["Actions Status", link="https://github.com/spring-cloud/spring-cloud-gateway/actions"] image::https://codecov.io/gh/spring-cloud/spring-cloud-gateway/branch/main/graph/badge.svg["Codecov", link="https://codecov.io/gh/spring-cloud/spring-cloud-gateway/branch/main"] [[features]] = Features • Java 17 • Spring Framework 6 • Spring Boot 3 • Dynamic routing • Route matching built into Spring Handler Mapping • Route matching on HTTP Request (Path, Method, Header, Host, etc...) • Filters scoped to Matching Route • Filters can modify downstream HTTP Request and HTTP Response (Add/Remove Headers, Add/Remove Parameters, Rewrite Path, Set Path, Circuit Breaker, etc...) • API or configuration driven • Supports Spring Cloud for configuring Routes [[building]] = Building :jdkversion: 17 [[basic-compile-and-test]] == Basic Compile and Test To build the source you will need to install JDK {jdkversion}. Spring Cloud uses Maven for most build-related activities, and you should be able to get off the ground quite quickly by cloning the project you are interested in and typing ---- $ ./mvnw install ---- NOTE: You can also install Maven (>=3.3.3) yourself and run the command in place of in the examples below. If you do that you also might need to add if your local Maven settings do not contain repository declarations for spring pre-release artifacts. NOTE: Be aware that you might need to increase the amount of memory available to Maven by setting a environment variable with a value like . We try to cover this in the configuration, so if you find you have to do it to make a build succeed, please raise a ticket to get the settings added to source control. The projects that require middleware (i.e. Redis) for testing generally require that a local instance of https://www.docker.com/get-started[Docker] is installed and running. [[documentation]] == Documentation The spring-cloud-build module has a "docs" profile, and if you switch that on it will try to build asciidoc sources using https://docs.antora.org/antora/latest/[Antora] from . As part of that process it will look for a and process it by loading all the includes, but not parsing or rendering it, just copying it to (defaults to , i.e. the root of the project). If there are any changes in the README it will then show up after a Maven build as a modified file in the correct place. Just commit it and push the change. [[working-with-the-code]] == Working with the code If you don't have an IDE preference we would recommend that you use https://spring.io/tools[Spring Tools Suite] or https://eclipse.org[Eclipse] when working with the code. We use the https://eclipse.org/m2e/[m2eclipse] eclipse plugin for maven support. Other IDEs and tools should also work without issue as long as they use Maven 3.3.3 or better. [[activate-the-spring-maven-profile]] === Activate the Spring Maven profile Spring Cloud projects require the 'spring' Maven profile to be activated to resolve the spring milestone and snapshot repositories. Use your preferred IDE to set this profile to be active, or you may experience build errors. [[importing-into-eclipse-with-m2eclipse]] === Importing into eclipse with m2eclipse We recommend the https://eclipse.org/m2e/[m2eclipse] eclipse plugin when working with eclipse. If you don't already have m2eclipse installed it is available from the "eclipse marketplace". NOTE: Older versions of m2e do not support Maven 3.3, so once the projects are imported into Eclipse you will also need to tell m2eclipse to use the right profile for the projects. If you see many different errors related to the POMs in the projects, check that you have an up to date installation. If you can't upgrade m2e, add the "spring" profile to your . Alternatively you can copy the repository settings from the "spring" profile of the parent pom into your . [[importing-into-eclipse-without-m2eclipse]] === Importing into eclipse without m2eclipse If you prefer not to use m2eclipse you can generate eclipse project metadata using the following command: [indent=0] ---- $ ./mvnw eclipse:eclipse ---- The generated eclipse projects can be imported by selecting from the menu. [[contributing]] = Contributing :spring-cloud-build-branch: main Spring Cloud is released under the non-restrictive Apache 2.0 license, and follows a very standard Github development process, using Github tracker for issues and merging pull requests into main. If you want to contribute even something trivial please do not hesitate, but follow the guidelines below. [[developer-certificate-of-origin]] == Developer Certificate of Origin (DCO) All commits must include a __Signed-off-by__ trailer at the end of each commit message to indicate that the contributor agrees to the Developer Certificate of Origin. For additional details, please refer to the blog post https://spring.io/blog/2025/01/06/hello-dco-goodbye-cla-simplifying-contributions-to-spring[Hello DCO, Goodbye CLA: Simplifying Contributions to Spring]. [[code-of-conduct]] == Code of Conduct This project adheres to the Contributor Covenant https://github.com/spring-cloud/spring-cloud-build/blob/main/docs/modules/ROOT/partials/code-of-conduct.adoc[code of conduct]. By participating, you are expected to uphold this code. Please report unacceptable behavior to code-of-conduct@spring.io. [[code-conventions-and-housekeeping]] == Code Conventions and Housekeeping None of these is essential for a pull request, but they will all help. They can also be added after the original pull request but before a merge. • Use the Spring Framework code format conventions. If you use Eclipse you can import formatter settings using the file from the https://raw.githubusercontent.com/spring…