Spring Boot的自动化配置特性来实现快速的将swagger2引入spring boot应用来生成jersey的API文档，简化原生使用swagger2的整合代码。

版本基础

Spring Boot：1.5.x
swagger-jersey2-jaxrs：2.7.x
Jersey 2

如何使用

在该项目的帮助下，我们的Spring Boot可以轻松的引入swagger2，主需要做下面两个步骤：

在pom.xml中引入依赖：

<dependency>
	<groupId>com.blueskykong</groupId>
	<artifactId>jersey-starter-swagger</artifactId>
	<version>1.0.0.RELEASE</version>
</dependency>

在应用主类中增加@EnableSwagger2Doc注解

@EnableSwagger2Doc
@SpringBootApplication
public class Bootstrap {

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

}

JerseyConfig 中增加

@PostConstruct
public void init() {
    this.register(ApiListingResource.class, SwaggerSerializers.class);
}

默认情况下就能产生所有当前jersey加载的请求映射文档。

参数配置

更细致的配置内容参考如下：

配置示例

swagger:
  enabled: true
  title: spring-boot-starter-swagger
  config-id: demo-mvc
  version: v2
  license: Apache License, Version 2.0
  licenseUrl: https://www.apache.org/licenses/LICENSE-2.0.html
  termsOfServiceUrl: http://git.oschina.net/keets/jersey-starter-swagger
  contact: keets
  base-path: /**
  resource-package: cn.keets.demo

配置说明

默认配置

- swagger.enabled=是否开启 // todo 实现线上关闭功能
- swagger.title=标题
- swagger.description=描述
- swagger.version=版本
- swagger.license=许可证
- swagger.licenseUrl=许可证URL
- swagger.termsOfServiceUrl=服务条款URL
- swagger.contact=维护人
- swagger.resource-package=swagger扫描的基础包，默认：全扫描
- swagger.base-path=需要处理的基础URL规则，默认：/**