spring-cloud-gateway-swagger2

Spring Boot Starter for spring-cloud-gateway-swagger2

简体中文 | English

Positioning · Capabilities · Dependency · Quick Start · Configuration · Versions · Build · License

---

Current Version：1.0.2-SNAPSHOT
JDK Baseline：17
Group ID：io.github.easy4j
Artifact ID：spring-cloud-gateway-swagger2
License：Apache License 2.0

1. Positioning

spring-cloud-gateway-swagger2 is a Spring Boot starter that integrates spring-cloud-gateway-swagger2 for applications using spring-cloud-gateway-swagger2. It provides auto-configuration, property binding, and ready-to-use beans so that applications can consume spring-cloud-gateway-swagger2 capabilities with minimal setup.

Dimension	Description
Type	Spring Boot Starter
Consumers	Spring Boot applications using spring-cloud-gateway-swagger2
Core Capabilities	auto-configuration, property binding, ready-to-use beans for spring-cloud-gateway-swagger2
JDK	17
Coordinates	io.github.easy4j:spring-cloud-gateway-swagger2:1.0.2-SNAPSHOT
Config Prefix	spring.cloud.gateway.swagger2

2. Core Capabilities

Capability	Status	Description
Auto-configuration	✅ Stable	Registers spring-cloud-gateway-swagger2 beans automatically
Property Binding	✅ Stable	Binds spring.cloud.gateway.swagger2.* to Swagger2GatewayProperties
UiConfiguration bean	✅ Stable	Auto-registered via Swagger2GatewayAutoConfiguration

3. Requirements and Compatibility

Dependency	Minimum	Evidence
JDK	17	pom.xml
Spring Boot	Hoxton.SR11	pom.xml parent
Maven	3.6+	Maven Enforcer

4. Auto-configuration

The starter auto-configures the following beans:

Bean	Condition	Missing Behavior
UiConfiguration	classpath + property	not created
return	classpath + property	not created
SwaggerResourcesProvider	classpath + property	not created
SwaggerResourceHandler	classpath + property	not created
SwaggerSecurityHandler	classpath + property	not created
SwaggerUiHandler	classpath + property	not created
SwaggerHeaderFilter	classpath + property	not created

Auto-configuration registration:

• META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports (Spring Boot 2.7+ / 3.x / 4.x)
• META-INF/spring.factories (Spring Boot 2.x legacy)

5. Dependency

<dependency>
    <groupId>io.github.easy4j</groupId>
    <artifactId>spring-cloud-gateway-swagger2</artifactId>
    <version>1.0.2-SNAPSHOT</version>
</dependency>

No additional easy4j component dependencies.

6. Quick Start

6.1 Add dependency

Add the dependency above to your pom.xml.

6.2 Configure

spring.cloud.gateway.swagger2:
  enabled: true

6.3 Use the bean

@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

Then inject the auto-configured bean in your code:

@Autowired
private UiConfiguration uiConfiguration;

7. Configuration Reference

7.1 Config Prefix

spring.cloud.gateway.swagger2

7.2 Configuration Items

Property	Type	Default	Required	Description	Sensitive
spring.cloud.gateway.swagger2.enabled	boolean	true	No	Enable the starter	No

8. Version Lines and Compatibility

Branch	JDK	Spring Boot	Component Version	Status
2.3.x / 2.7.x	8+	2.3.x / 2.7.x	1.0.x	Maintenance
3.0.x ~ 3.5.x	17	3.x	2.0.x	Maintenance
4.0.x / 4.1.x	17+	4.x	3.0.x	Active

9. Build and Test

mvn clean verify
mvn -pl spring-cloud-gateway-swagger2 -am test

10. Troubleshooting

Symptom	Diagnosis	Resolution
Bean not created	Check auto-configuration report	Verify spring.cloud.gateway.swagger2.enabled=true and classpath
ClassNotFoundException	Missing dependency	Add the required module
Version conflict	mvn dependency:tree	Use BOM for version alignment

11. Contribution

1. Fork the repository.
2. Create a feature branch.
3. Run mvn clean verify before submitting.
4. Submit a pull request.

12. License

This project is licensed under the Apache License, Version 2.0.

---

Back to top · Issues · Repository