Skip to content

Commit 83a1d79

Browse files
committed
修改文档
1 parent f218993 commit 83a1d79

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
<dependency>
2727
<groupId>com.didispace</groupId>
2828
<artifactId>spring-boot-starter-swagger</artifactId>
29-
<version>1.3.0.RELEASE</version>
29+
<version>1.4.0.RELEASE</version>
3030
</dependency>
3131
```
3232

@@ -53,9 +53,11 @@ public class Bootstrap {
5353
## 配置示例
5454

5555
```properties
56+
swagger.enabled=true
57+
5658
swagger.title=spring-boot-starter-swagger
5759
swagger.description=Starter for swagger 2.x
58-
swagger.version=1.3.0.RELEASE
60+
swagger.version=1.4.0.RELEASE
5961
swagger.license=Apache License, Version 2.0
6062
swagger.licenseUrl=https://www.apache.org/licenses/LICENSE-2.0.html
6163
swagger.termsOfServiceUrl=https://github.com/dyc87112/spring-boot-starter-swagger
@@ -65,6 +67,7 @@ swagger.contact.email=dyc87112@qq.com
6567
swagger.base-package=com.didispace
6668
swagger.base-path=/**
6769
swagger.exclude-path=/error, /ops/**
70+
6871
swagger.globalOperationParameters[0].name=name one
6972
swagger.globalOperationParameters[0].description=some description one
7073
swagger.globalOperationParameters[0].modelRef=string
@@ -82,6 +85,7 @@ swagger.globalOperationParameters[1].required=false
8285
### 默认配置
8386

8487
```
88+
- swagger.enabled=是否启用swagger,默认:true
8589
- swagger.title=标题
8690
- swagger.description=描述
8791
- swagger.version=版本
@@ -103,7 +107,11 @@ swagger.globalOperationParameters[1].required=false
103107
```
104108

105109

106-
> host属性从1.3.0.RELEASE开始支持
110+
> `1.3.0.RELEASE`新增:`swagger.host`属性,同时也支持指定docket的配置
111+
>
112+
> `1.4.0.RELEASE`新增:
113+
> - `swagger.enabled`:用于开关swagger的配置
114+
> - `swagger.globalOperationParameters`:用于设置全局的参数,比如:header部分的accessToken等。该参数支持指定docket的配置。
107115
108116
### Path规则说明
109117

@@ -176,13 +184,9 @@ swagger.docket.aaa.globalOperationParameters[0].parameterType=header
176184

177185
swagger.docket.bbb.title=group-bbb
178186
swagger.docket.bbb.basePackage=com.yonghui
179-
180-
181187
```
182188

183-
说明:默认配置与分组配置可以一起使用。在分组配置中没有配置的内容将使用默认配置替代,所以默认配置可以作为分组配置公共部分属性的配置。
184-
185-
`swagger.docket.aaa.globalOperationParameters[0].name` 会覆盖同名的全局配置
189+
说明:默认配置与分组配置可以一起使用。在分组配置中没有配置的内容将使用默认配置替代,所以默认配置可以作为分组配置公共部分属性的配置。`swagger.docket.aaa.globalOperationParameters[0].name`会覆盖同名的全局配置。
186190

187191
### JSR-303校验注解支持
188192

0 commit comments

Comments
 (0)