发布：1.1.0.RELEASE

Author: dyc87112

README.md

@@ -1,6 +1,11 @@
 # spring-boot-starter-swagger
 
-该项目主要利用Spring Boot的自动化配置特性来实现快速的将swagger2引入spring boot应用来生成API文档。
+该项目主要利用Spring Boot的自动化配置特性来实现快速的将swagger2引入spring boot应用来生成API文档，简化原生使用swagger2的整合代码。
+
+# 版本基础
+
+- Spring Boot：1.5.x
+- Swagger：2.7.x
 
 # 如何使用
 
@@ -12,7 +17,7 @@
 <dependency>
 	<groupId>com.didispace</groupId>
 	<artifactId>spring-boot-starter-swagger</artifactId>
-	<version>1.0.0.RELEASE</version>
+	<version>1.1.0.RELEASE</version>
 </dependency>
 ```
 
@@ -30,24 +35,59 @@ public class Bootstrap {
 }
 ```
 
-默认情况下就能产生所有Spring MVC加载的请求文档了。
+默认情况下就能产生所有当前Spring MVC加载的请求映射文档。
 
 # 参数配置
 
-更细致的配置文档内容，可以参考如下参数：
+更细致的配置内容参考如下：
+
+**配置示例**
+
+```properties
+swagger.title=spring-boot-starter-swagger
+swagger.description=Starter for swagger 2.x
+swagger.version=1.1.0.RELEASE
+swagger.license=Apache License, Version 2.0
+swagger.licenseUrl=https://www.apache.org/licenses/LICENSE-2.0.html
+swagger.termsOfServiceUrl=https://github.com/dyc87112/spring-boot-starter-swagger
+swagger.contact.name=程序猿DD
+swagger.contact.url=http://blog.didispace.com
+swagger.contact.email=dyc87112@qq.com
+swagger.base-package=com.didispace
+swagger.base-path=/**
+swagger.exclude-path=/error, /ops/**
+```
+
+**配置说明**
+
+- swagger.title=标题
+- swagger.description=描述
+- swagger.version=版本
+- swagger.license=许可证
+- swagger.licenseUrl=许可证URL
+- swagger.termsOfServiceUrl=服务条款URL
+- swagger.contact.name=维护人
+- swagger.contact.url=维护人URL
+- swagger.contact.email=维护人email
+- swagger.base-package=swagger扫描的基础包，默认：全扫描
+- swagger.base-path=需要处理的基础URL规则，默认：/**
+- swagger.exclude-path=需要排除的URL规则，默认：空
+
+## Path规则说明
+
+`swagger.base-path`和`swagger.exclude-path`使用ANT规则配置。
+
+我们可以使用`swagger.base-path`来指定所有需要生成文档的请求路径基础规则，然后再利用`swagger.exclude-path`来剔除部分我们不需要的。
+
+比如，通常我们可以这样设置：
 
 ```properties
-swagger.title=标题
-swagger.description=描述
-swagger.version=版本
-swagger.license=许可证
-swagger.licenseUrl=许可证URL
-swagger.termsOfServiceUrl=服务条款URL
-swagger.contact.name=维护人
-swagger.contact.url=维护人URL
-swagger.contact.email=维护人email
-swagger.base-path=产生文档的基础URL规则，默认：/**
-swagger.exclude-path=需要排除的URL规则，默认为空
+management.context-path=/ops
+
+swagger.base-path=/**
+swagger.exclude-path=/ops/**, /error
 ```
 
-`swagger.base-path`和`swagger.exclude-path`使用ANT规则配置
+上面的设置将解析所有除了`/ops/`开始以及spring boot自带`/error`请求路径。
+
+其中，`exclude-path`可以配合`management.context-path=/ops`设置的spring boot actuator的context-path来排除所有监控端点。

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>com.didispace</groupId>
     <artifactId>spring-boot-starter-swagger</artifactId>
-    <version>1.0.0.RELEASE</version>
+    <version>1.1.0.RELEASE</version>
 
     <name>spring-boot-starter-swagger</name>
     <url>https://github.com/dyc87112/spring-boot-starter-swagger</url>
@@ -62,11 +62,13 @@
             <groupId>io.springfox</groupId>
             <artifactId>springfox-swagger-ui</artifactId>
             <version>${version.swagger}</version>
+            <scope>compile</scope>
         </dependency>
         <dependency>
             <groupId>io.springfox</groupId>
             <artifactId>springfox-swagger2</artifactId>
             <version>${version.swagger}</version>
+            <scope>compile</scope>
         </dependency>
         <dependency>
             <groupId>org.projectlombok</groupId>

src/main/java/com/didispace/swagger/SwaggerAutoConfiguration.java

@@ -7,6 +7,7 @@
 import org.springframework.context.annotation.Configuration;
 import springfox.documentation.builders.ApiInfoBuilder;
 import springfox.documentation.builders.PathSelectors;
+import springfox.documentation.builders.RequestHandlerSelectors;
 import springfox.documentation.service.ApiInfo;
 import springfox.documentation.service.Contact;
 import springfox.documentation.spi.DocumentationType;
@@ -44,16 +45,17 @@ public Docket createRestApi(SwaggerProperties swaggerProperties) {
                 .termsOfServiceUrl(swaggerProperties.getTermsOfServiceUrl())
                 .build();
 
+        // base-path处理
         // 当没有配置任何path的时候，解析/**
         if(swaggerProperties.getBasePath().isEmpty()) {
             swaggerProperties.getBasePath().add("/**");
         }
-
         List<Predicate<String>> basePath = new ArrayList();
         for(String path : swaggerProperties.getBasePath()) {
             basePath.add(PathSelectors.ant(path));
         }
 
+        // exclude-path处理
         List<Predicate<String>> excludePath = new ArrayList();
         for(String path : swaggerProperties.getExcludePath()) {
             excludePath.add(PathSelectors.ant(path));
@@ -62,6 +64,7 @@ public Docket createRestApi(SwaggerProperties swaggerProperties) {
         return new Docket(DocumentationType.SWAGGER_2)
                 .apiInfo(apiInfo)
                 .select()
+                .apis(RequestHandlerSelectors.basePackage(swaggerProperties.getBasePackage()))
                 .paths(
                         Predicates.and(
                                 Predicates.not(Predicates.or(excludePath)),

src/main/java/com/didispace/swagger/SwaggerProperties.java

@@ -31,6 +31,9 @@ public class SwaggerProperties {
 
     private Contact contact = new Contact();
 
+    /**swagger会解析的包路径**/
+    private String basePackage = "";
+
     /**swagger会解析的url规则**/
     private List<String> basePath = new ArrayList<>();
     /**在basePath基础上需要排除的url规则**/