Skip to content

[feat] modify swagger #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yu199195 merged 1 commit into from
Mar 4, 2025
Merged

[feat] modify swagger #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion shenyu-java-examples/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<versions-maven-plugin.version>2.5</versions-maven-plugin.version>
<docker-maven-plugin.version>0.40.1</docker-maven-plugin.version>
<maven-checkstyle-plugin.version>3.4.0</maven-checkstyle-plugin.version>
<swagger.version>2.9.2</swagger.version>
<swagger.version>2.10.0</swagger.version>
</properties>

<modules>
Expand Down
93 changes: 43 additions & 50 deletions ...p-swagger2/src/main/java/org/apache/shenyu/examples/http/config/SwaggerConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,10 @@
package org.apache.shenyu.examples.http.config;

import io.swagger.annotations.ApiOperation;
import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
import java.util.stream.Collectors;
import org.apache.shenyu.common.constant.Constants;
import org.apache.shenyu.common.utils.VersionUtils;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.config.BeanPostProcessor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.util.ReflectionUtils;
import org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
Expand All @@ -41,14 +32,16 @@
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.spring.web.plugins.WebMvcRequestHandlerProvider;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;

import java.util.ArrayList;
import java.util.List;

/**
* Configuration class for Swagger API document.
*/
@Configuration
@EnableSwagger2
@EnableSwagger2WebMvc
public class SwaggerConfiguration {

private static final String DEFAULT_SWAGGER_API_VERSION = "2.3.0";
Expand Down Expand Up @@ -103,44 +96,44 @@ public Docket createRestApi() {
.build();
}

/**
* use bean to be compatible with springboot 2.6.8.
*
* @return BeanPostProcessor
*/
@Bean
public BeanPostProcessor springfoxBeanHandler() {
return new BeanPostProcessor() {
@Override
public Object postProcessAfterInitialization(final Object bean,
final String beanName) throws BeansException {
if (bean instanceof WebMvcRequestHandlerProvider) {
customizeSpringfoxHandlerMappings(getHandlerMappings(bean));
}
return bean;
}

private <T extends RequestMappingInfoHandlerMapping> void customizeSpringfoxHandlerMappings(
final List<T> mappings) {
List<T> copy = mappings.stream()
.filter(mapping -> Objects.isNull(mapping.getPatternParser()))
.collect(Collectors.toList());
mappings.clear();
mappings.addAll(copy);
}

@SuppressWarnings("unchecked")
private List<RequestMappingInfoHandlerMapping> getHandlerMappings(final Object bean) {
try {
Field field = ReflectionUtils.findField(bean.getClass(), "handlerMappings");
field.setAccessible(true);
return (List<RequestMappingInfoHandlerMapping>) field.get(bean);
} catch (IllegalArgumentException | IllegalAccessException e) {
throw new IllegalStateException(e);
}
}
};
}
// /**
// * use bean to be compatible with springboot 2.6.8.
// *
// * @return BeanPostProcessor
// */
// @Bean
// public BeanPostProcessor springfoxBeanHandler() {
// return new BeanPostProcessor() {
// @Override
// public Object postProcessAfterInitialization(final Object bean,
// final String beanName) throws BeansException {
// if (bean instanceof WebMvcRequestHandlerProvider) {
// customizeSpringfoxHandlerMappings(getHandlerMappings(bean));
// }
// return bean;
// }
//
// private <T extends RequestMappingInfoHandlerMapping> void customizeSpringfoxHandlerMappings(
// final List<T> mappings) {
// List<T> copy = mappings.stream()
// .filter(mapping -> Objects.isNull(mapping.getPatternParser()))
// .collect(Collectors.toList());
// mappings.clear();
// mappings.addAll(copy);
// }
//
// @SuppressWarnings("unchecked")
// private List<RequestMappingInfoHandlerMapping> getHandlerMappings(final Object bean) {
// try {
// Field field = ReflectionUtils.findField(bean.getClass(), "handlerMappings");
// field.setAccessible(true);
// return (List<RequestMappingInfoHandlerMapping>) field.get(bean);
// } catch (IllegalArgumentException | IllegalAccessException e) {
// throw new IllegalStateException(e);
// }
// }
// };
// }

/**
* Fetch version information from pom.xml and set title, version, description,
Expand Down
Loading