文档调整

Author: dyc87112

README.md

@@ -1,7 +1,5 @@
 # 简介
 
-[![Build Status](https://travis-ci.org/dyc87112/spring-boot-starter-swagger.svg?branch=1.5.0)](https://travis-ci.org/dyc87112/spring-boot-starter-swagger)
-
 该项目主要利用Spring Boot的自动化配置特性来实现快速的将swagger2引入spring boot应用来生成API文档，简化原生使用swagger2的整合代码。
 
 - 源码地址
@@ -34,7 +32,7 @@
 </dependency>
 ```
 
-**注意：从`1.6.1`开始，我们按Spring Boot官方建议修改了artifactId为`swagger-spring-boot-starter`，1.6.0之前的版本不做修改，依然为使用`spring-boot-starter-swagger` !**
+**注意：从`1.6.0`开始，我们按Spring Boot官方建议修改了artifactId为`swagger-spring-boot-starter`，1.6.0之前的版本不做修改，依然为使用`spring-boot-starter-swagger` !**
 
 - 在应用主类中增加`@EnableSwagger2Doc`注解
 
@@ -251,19 +249,34 @@ swagger.ui-config.submit-methods=get,delete
 swagger.ui-config.submit-methods=
 ```
 
----
+- 其他配置
 
-### 来自2018年的版本升级，欢呼吧，Coder们
+```properties
+# json编辑器
+swagger.ui-config.json-editor=false
 
-> 2018-03-21 今日春分，细雨如风 `1.7.0` 版本诞生 @gumutianqi
+# 显示请求头
+swagger.ui-config.show-request-headers=true
 
-#### UI升级到 2.8.0 版本 (1.7.0 + 支持)
+# 页面调试请求的超时时间
+swagger.ui-config.request-timeout=5000
+```
 
-- 扁平化设计
-- 更加华丽
-- 更加易用
-- 可配置项更加自由
+### ignoredParameterTypes配置（1.6.0 + 支持）
 
+```properties
+# 基础配置
+swagger.ignored-parameter-types[0]=com.didispace.demo.User
+swagger.ignored-parameter-types[1]=com.didispace.demo.Product
+
+# 分组配置
+swagger.docket.aaa.ignored-parameter-types[0]=com.didispace.demo.User
+swagger.docket.aaa.ignored-parameter-types[1]=com.didispace.demo.Product
+```
+
+> 该参数作用：
+> Q. Infinite loop when springfox tries to determine schema for objects with nested/complex constraints?
+> A. If you have recursively defined objects, I would try and see if providing an alternate type might work or perhaps even ignoring the offending classes e.g. order using the docket. ignoredParameterTypes(Order.class). This is usually found in Hibernate domain objects that have bidirectional dependencies on other objects.
 
 ### Authorization 鉴权配置 (1.7.0 + 支持)
 
@@ -282,7 +295,7 @@ swagger.authorization.auth-regex=^.*$
 
 备注：目前支持`ApiKey`鉴权模式，后续添加`Oauth2`和`BasicAuth`支持
 
-##### 使用须知
+**使用须知**
 
 > 1. 默认已经在全局开启了`global`的SecurityReferences，无需配置任何参数就可以使用；
 > 2. 全局鉴权的范围在可以通过以上参数`auth-regex`进行正则表达式匹配控制；
@@ -295,7 +308,7 @@ swagger.authorization.auth-regex=^.*$
 String hello();
 ```
 
-##### 关于如何配置实现鉴权，请关注以下code：
+**关于如何配置实现鉴权，请关注以下code：**
 
 ```java
 /**
@@ -337,36 +350,6 @@ private List<SecurityReference> defaultAuth() {
 }
 ```
 
-
-- 其他配置
-
-```properties
-# json编辑器
-swagger.ui-config.json-editor=false
-
-# 显示请求头
-swagger.ui-config.show-request-headers=true
-
-# 页面调试请求的超时时间
-swagger.ui-config.request-timeout=5000
-```
-
-### ignoredParameterTypes配置（1.6.0 + 支持）
-
-```properties
-# 基础配置
-swagger.ignored-parameter-types[0]=com.didispace.demo.User
-swagger.ignored-parameter-types[1]=com.didispace.demo.Product
-
-# 分组配置
-swagger.docket.aaa.ignored-parameter-types[0]=com.didispace.demo.User
-swagger.docket.aaa.ignored-parameter-types[1]=com.didispace.demo.Product
-```
-
-> 该参数作用：
-> Q. Infinite loop when springfox tries to determine schema for objects with nested/complex constraints?
-> A. If you have recursively defined objects, I would try and see if providing an alternate type might work or perhaps even ignoring the offending classes e.g. order using the docket. ignoredParameterTypes(Order.class). This is usually found in Hibernate domain objects that have bidirectional dependencies on other objects.
-
 ## 贡献者
 
 - [程序猿DD-翟永超](https://github.com/dyc87112/)