message.swagger.config.CosmosSwaggerPlugin Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lodsve-mvc Show documentation

spring-mvc和swagger相关封装

There is a newer version: 2.5.9

package message.swagger.config;

import com.mangofactory.swagger.configuration.SpringSwaggerConfig;
import com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin;
import com.wordnik.swagger.model.ApiInfo;
import message.properties.SwaggerProperties;
import message.swagger.annotations.SwaggerIgnore;
import message.swagger.paths.CosmosSwaggerPathProvider;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

/**
 * 利用插件配置swagger的一些信息.
 *
 * @author sunhao([email protected])
 * @version V1.0, 16/1/18 下午6:25
 */
@Component
public class CosmosSwaggerPlugin extends SwaggerSpringMvcPlugin {
    /**
     * Default constructor.
     * The argument springSwaggerConfig is used to by this class to establish sensible defaults.
     *
     * @param springSwaggerConfig
     */
    @Autowired
    public CosmosSwaggerPlugin(SpringSwaggerConfig springSwaggerConfig, SwaggerProperties swaggerProperties, CosmosSwaggerPathProvider pathProvider) {
        super(springSwaggerConfig);

        apiInfo(getApiInfo(swaggerProperties));
        swaggerGroup("group");
        includePatterns(".*?");
        excludeAnnotations(SwaggerIgnore.class);
        pathProvider(pathProvider);
    }

    private ApiInfo getApiInfo(SwaggerProperties swaggerProperties) {
        return new ApiInfo(
                swaggerProperties.getTitle(),
                swaggerProperties.getDescription(),
                swaggerProperties.getTermsOfServiceUrl(),
                swaggerProperties.getContact(),
                swaggerProperties.getLicense(),
                swaggerProperties.getLicenseUrl()
        );
    }
}