Make base path configurable for WebFlux applications

[bonigarcia]

So far (Spring Boot 1.5.4-RELEASE) I were using the configuration key server.contextPath of application.properties to change the context path of a Spring Boot based web application, as follows:

server.contextPath=/mypath

Unfortunately, this has stopped working when upgrading to Spring Boot 2.0.0-M3.

Is this a bug or this feature has changed in Spring Boot 2?

[wilkinsona]

Configuring the context path is servlet-specific. To reflect that fact and avoid confusion when using WebFlux, the configuration property was renamed to server.servlet.context-path. That should have been mentioned in the M1 release notes but it looks like we missed it.

[wilkinsona]

These are the changes that need to be described in the release notes: 12d883f

[snicoll]

@bonigarcia which IDE are you using? As of M4, it should show up in red

[wilkinsona]

I've updated the release notes to describe the changes. Thanks for bringing this to our attention, @bonigarcia.

[bonigarcia]

Thank you very much, using server.servlet.context-path my app is working again as expected.

@snicoll I am using Eclipse 4.7 (Oxygen), but without any specific Spring plugin (I think that way is impossible for the IDE to warn me about the problem)

Keep up the great work!

[danieldelatorre]

Hello,

I am using spring boot 2.0.0.M4/7 and I used the server.servlet.context-path=/mypath but it dpes not work. I can reach my rest endpoints using the url without the path.
Can you help me with this?

[danieldelatorre]

Also I want to add that I am using webflux, maybe webflux does not support that property.

[philwebb]

@danieldelatorre That property is only for servlet based deployments. I don't think we have an equivalent for webflux (do we @bclozel?).

[bclozel]

In Spring Framework, there are several ways to deal with context paths:

• deploying your WebFlux app as a war in a Servlet container and configure the Servlet to a particular context path. Spring Boot does not support WebFlux war deployment.
• Spring Framework provides a ContextPathCompositeHandler that allows delegating to multiple HttpHandler instances depending on the path. With @EnableWebFlux, you can provide both WebFlux annotation and WebFlux functional handlers and they'll be mapped accordingly.

While we could leverage that last bit and map the whole WebFlux application to a particular context, I don't see the real added value since we don't deploy to war nor map multiple HttpHandler instances. We'd just have everything mapped under one path.

[danieldelatorre]

ok thanks for the quick answer.
One last question if I add to the pom.xml the spring-boot-starter-webflux and the spring-boot-starter-web the server.servlet.context-path works. If I add both references in the pom how can my service be impacted?

[bclozel]

If you add both starters, your application is a Spring MVC app. Note that as of Spring Framework 5, Spring MVC knows how to handle a few cases with Flux at the controller level.

[danieldelatorre]

But if my application is using Flux and Mono in the RestController, it will continue using non blocking calls right?