spring-cloud / spring-cloud/spring-cloud-gateway
Provide documentation on when to use the MVC and when to use the WebFlux variant
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 4.9k
- Forks
- 3.5k
- Avg merge
- 20h 57m
- Merged PRs (30d)
- 8
Description
Is your feature request related to a problem? Please describe.
I think there should be documentation providing reasons for why one would choose the MVC over the WebFlux variant or vice versa.
Describe the solution you'd like
A document with the pros and cons; mentioning developer experience, deployment, operational, and performance implications.
Describe alternatives you've considered
I cannot find any good information other than "some people do not want Netty"/"it's newer".
Additional context
An official performance comparison between the two variants is not strictly part of this PR but it would be nice to have regardless:
https://github.com/spring-cloud/spring-cloud-gateway/issues/3058
https://github.com/spring-cloud/spring-cloud-gateway/issues/2067
https://github.com/spencergibb/spring-cloud-gateway-bench
These do not mention why one would choose one over the other:
Getting Started with Spring Cloud Gateway
Spring Cloud Gateway/Introduction
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Spring Cloud Gateway reference index and the linked Getting Started article to identify where guidance on MVC and WebFlux belongs. Review the linked performance issues and benchmark repository for context, then document the developer experience, deployment, operational, and performance considerations that inform the choice; an official comparison is optional rather than required.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, spring-boot
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100