net.guerlab.spring.swagger2.autoconfigure.Swagger2ControllerAutoConfigure Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of guerlab-spring-swagger2-starter Show documentation
There is a newer version: 2.1.5
Show newest version
package net.guerlab.spring.swagger2.autoconfigure;

import java.util.Optional;

import javax.servlet.http.HttpServletRequest;

import org.apache.commons.lang3.StringUtils;
import org.springframework.beans.BeanUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Conditional;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import org.springframework.web.util.UriComponents;

import io.swagger.models.Swagger;
import net.guerlab.commons.exception.ApplicationException;
import net.guerlab.spring.commons.annotation.IgnoreResponseHandler;
import net.guerlab.spring.commons.util.SpringApplicationContextUtil;
import net.guerlab.spring.swagger2.HostNameProvider;
import springfox.documentation.annotations.ApiIgnore;
import springfox.documentation.service.Documentation;
import springfox.documentation.spring.web.DocumentationCache;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.mappers.ServiceModelToSwagger2Mapper;

/**
 * swagger2 controller with spring cloud
 *
 * @author guer
 *
 */
@Configuration
@Conditional(SwaggerEnableCondition.class)
public class Swagger2ControllerAutoConfigure implements WebMvcConfigurer {

    /**
     * 基础路径
     */
    public static final String BASE_PATH = "/swagger-cloud";

    /**
     * swagger2 controller with spring cloud
     *
     * @author guer
     *
     */
    @ApiIgnore
    @IgnoreResponseHandler
    @RestController
    @RequestMapping(Swagger2ControllerAutoConfigure.BASE_PATH)
    public static class Swagger2Controller {

        @Autowired
        private DocumentationCache documentationCache;

        @Autowired
        private ServiceModelToSwagger2Mapper mapper;

        /**
         * get Documentation
         *
         * @param swaggerGroup
         *            swagger Group
         * @param servletRequest
         *            request
         * @return swagger
         */
        @GetMapping("/v2/api-docs")
        public Swagger getDocumentation(@RequestParam(value = "group", required = false) String swaggerGroup,
                HttpServletRequest servletRequest) {
            String groupName = Optional.ofNullable(swaggerGroup).orElse(Docket.DEFAULT_GROUP_NAME);

            Documentation documentation = documentationCache.documentationByGroup(groupName);

            if (documentation == null) {
                throw new ApplicationException("not find group[group=" + groupName + "]");
            }

            Swagger swagger = mapper.mapDocumentation(documentation);
            Swagger swagger2 = new Swagger();

            BeanUtils.copyProperties(swagger, swagger2);

            UriComponents uriComponents = HostNameProvider.componentsFrom(servletRequest, swagger2.getBasePath());

            String forwardedHost = servletRequest.getHeader("x-forwarded-host");

            if (StringUtils.isNotBlank(forwardedHost)) {
                swagger2.host(forwardedHost);
                setBasePath(swagger2, servletRequest.getHeader("x-forwarded-prefix"));
            } else {
                swagger2.basePath(StringUtils.isBlank(uriComponents.getPath()) ? "/" : uriComponents.getPath());

                if (StringUtils.isBlank(swagger2.getHost())) {
                    swagger2.host(hostName(uriComponents));
                }
            }

            return swagger2;
        }

        private void setBasePath(Swagger swagger2, String forwardedPrefix) {
            if (setBasePathSpringCloudZuulSupport(swagger2, forwardedPrefix)) {
                return;
            }

            setBasePathGeneralSupport(swagger2);
        }

        /**
         * spring cloud 1.X 下zull的支持,需要在zuul增加zuul.add-host-header=true配置
         */
        private boolean setBasePathSpringCloudZuulSupport(Swagger swagger2, String forwardedPrefix) {
            if (StringUtils.isNotBlank(forwardedPrefix)) {
                swagger2.setBasePath(forwardedPrefix);
                return true;
            }
            return false;
        }

        /**
         * 通用支持,用于支持在服务注册后根据注册名称自动做匹配,适用于1.X的zuul的自动发现和2.X的gateway的自动支持

         * 2.X gateway的自动发现请参考http://cloud.spring.io/spring-cloud-static/Finchley.RC2/single/spring-cloud.html#_discoveryclient_route_definition_locator
         */
        private void setBasePathGeneralSupport(Swagger swagger2) {
            Environment environment = SpringApplicationContextUtil.getContext().getEnvironment();

            String appName = environment.getProperty("eureka.instance.appname",
                    environment.getProperty("spring.application.name"));

            if (StringUtils.isNotBlank(appName)) {
                swagger2.setBasePath("/" + appName.toUpperCase());
            }
        }

        private String hostName(UriComponents uriComponents) {
            String host = uriComponents.getHost();
            int port = uriComponents.getPort();
            if (port > -1) {
                return String.format("%s:%d", host, port);
            }
            return host;
        }
    }
}