spring-cloud/spring-cloud-gateway

Document that spring-cloud-gateway-mvc is not compatible with spring-cloud-gateway-core

Open

#1004 opened on Apr 9, 2019

View on GitHub
 (15 comments) (0 reactions) (0 assignees)Java (4,284 stars) (3,204 forks)batch import
documentationhelp wanted

Description

This is similar to #319 . Application created using http://start.spring.io with gateway dependency and with additional spring-cloud-gateway-mvc fails.

 <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-gateway-mvc</artifactId>
  </dependency>

If spring-boot-starter-web is not compatible, then what is the purpose of this dependency?

Error:

Consider defining a bean of type 'org.springframework.http.codec.ServerCodecConfigurer' in your configuration.

Documentation: https://cloud.spring.io/spring-cloud-gateway/multi/multi__building_a_simple_gateway_using_spring_mvc_or_webflux.html

Contributor guide

Tech stack
java
Domain
backenddocumentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Spring Cloud Gateway basicsdependency management understanding
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Investigate the existing documentation at https://cloud.spring.io/spring cloud gateway/multi/multi building a simple gateway using spring mvc or webflux.html and issue #319. Add a clear warning that spring cloud gateway mvc is incompatible with spring cloud gateway core when using spring boot starter web, explaining the ServerCodecConfigurer error and recommending alternatives.