Skip to content

Commit 7e0bf58

Browse files
committed
1.3.0 文档修改
1 parent 28443bf commit 7e0bf58

File tree

3 files changed

+29
-3
lines changed

3 files changed

+29
-3
lines changed

README.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ swagger.exclude-path=/error, /ops/**
7171

7272
### 默认配置
7373

74+
```
7475
- swagger.title=标题
7576
- swagger.description=描述
7677
- swagger.version=版本
@@ -83,6 +84,10 @@ swagger.exclude-path=/error, /ops/**
8384
- swagger.base-package=swagger扫描的基础包,默认:全扫描
8485
- swagger.base-path=需要处理的基础URL规则,默认:/**
8586
- swagger.exclude-path=需要排除的URL规则,默认:空
87+
- swagger.host=文档的host信息,默认:空
88+
```
89+
90+
**host属性从1.3.0.RELEASE开始支持**
8691

8792
### Path规则说明
8893

@@ -111,6 +116,7 @@ swagger.exclude-path=/ops/**, /error
111116

112117
具体配置内容如下:
113118

119+
```
114120
- swagger.docket.<name>.title=标题
115121
- swagger.docket.<name>.description=描述
116122
- swagger.docket.<name>.version=版本
@@ -123,6 +129,7 @@ swagger.exclude-path=/ops/**, /error
123129
- swagger.docket.<name>.base-package=swagger扫描的基础包,默认:全扫描
124130
- swagger.docket.<name>.base-path=需要处理的基础URL规则,默认:/**
125131
- swagger.docket.<name>.exclude-path=需要排除的URL规则,默认:空
132+
```
126133

127134
说明:`<name>`为swagger文档的分组名称,同一个项目中可以配置多个分组,用来划分不同的API文档。
128135

@@ -131,7 +138,7 @@ swagger.exclude-path=/ops/**, /error
131138
```properties
132139
swagger.docket.aaa.title=group-a
133140
swagger.docket.aaa.description=Starter for swagger 2.x
134-
swagger.docket.aaa.version=1.2.0.RELEASE
141+
swagger.docket.aaa.version=1.3.0.RELEASE
135142
swagger.docket.aaa.termsOfServiceUrl=https://gitee.com/didispace/spring-boot-starter-swagger
136143
swagger.docket.aaa.contact.name=zhaiyongchao
137144
swagger.docket.aaa.contact.url=http://spring4all.com/
@@ -146,4 +153,18 @@ swagger.docket.bbb.basePackage=com.yonghui
146153

147154
### JSR-303校验注解支持
148155

149-
TODO 待完善内容
156+
支持对JSR-303校验注解的展示,如下图所示:
157+
158+
![JSR-303校验展示](https://github.com/dyc87112/spring-boot-starter-swagger/blob/master/images/jsr-303.png)
159+
160+
目前共支持以下几个注解:
161+
162+
- `@NotNull`
163+
- `@Max、@Min`
164+
- `@Size`
165+
- `@Pattern`
166+
167+
## 贡献者
168+
169+
- [程序猿DD-翟永超](https://github.com/dyc87112/)
170+
- [小火](https://renlulu.github.io/)

images/jsr-303.png

40.9 KB
Loading

pom.xml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
<groupId>com.didispace</groupId>
88
<artifactId>spring-boot-starter-swagger</artifactId>
9-
<version>1.3.0.SNAPSHOT</version>
9+
<version>1.3.0.RELEASE</version>
1010

1111
<name>spring-boot-starter-swagger</name>
1212
<url>https://github.com/dyc87112/spring-boot-starter-swagger</url>
@@ -38,6 +38,11 @@
3838
<email>dyc87112@qq.com</email>
3939
<organization>http://didispace.com</organization>
4040
</developer>
41+
<developer>
42+
<name>小火</name>
43+
<email>xiaohuo200@gmail.com</email>
44+
<organization>https://renlulu.github.io/</organization>
45+
</developer>
4146
</developers>
4247

4348
<properties>

0 commit comments

Comments
 (0)