Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
程序猿小郑
microservices-platform
提交
b3afeeae
microservices-platform
项目概览
程序猿小郑
/
microservices-platform
与 Fork 源项目一致
Fork自
zlt2000 / microservices-platform
通知
4
Star
1
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
microservices-platform
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
前往新版Gitcode,体验更适合开发者的 AI 搜索 >>
提交
b3afeeae
编写于
1月 29, 2019
作者:
zlt2000
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
修改环境配置
上级
3027277c
变更
6
隐藏空白更改
内联
并排
Showing
6 changed file
with
3 addition
and
138 deletion
+3
-138
zlt-commons/zlt-common-spring-boot-starter.rar
zlt-commons/zlt-common-spring-boot-starter.rar
+0
-0
zlt-commons/zlt-common-spring-boot-starter/pom.xml
zlt-commons/zlt-common-spring-boot-starter/pom.xml
+1
-0
zlt-commons/zlt-log-spring-boot-starter.rar
zlt-commons/zlt-log-spring-boot-starter.rar
+0
-0
zlt-commons/zlt-swagger2-spring-boot-starter/README.md
zlt-commons/zlt-swagger2-spring-boot-starter/README.md
+0
-136
zlt-config/src/main/resources/application-test.properties
zlt-config/src/main/resources/application-test.properties
+1
-1
zlt-config/src/main/resources/application.properties
zlt-config/src/main/resources/application.properties
+1
-1
未找到文件。
zlt-commons/zlt-common-spring-boot-starter.rar
已删除
100644 → 0
浏览文件 @
3027277c
文件已删除
zlt-commons/zlt-common-spring-boot-starter/pom.xml
浏览文件 @
b3afeeae
...
@@ -8,6 +8,7 @@
...
@@ -8,6 +8,7 @@
</parent>
</parent>
<artifactId>
zlt-common-spring-boot-starter
</artifactId>
<artifactId>
zlt-common-spring-boot-starter
</artifactId>
<description>
公共通用组件
</description>
<description>
公共通用组件
</description>
<packaging>
jar
</packaging>
<dependencies>
<dependencies>
<dependency>
<dependency>
<groupId>
com.zlt
</groupId>
<groupId>
com.zlt
</groupId>
...
...
zlt-commons/zlt-log-spring-boot-starter.rar
已删除
100644 → 0
浏览文件 @
3027277c
文件已删除
zlt-commons/zlt-swagger2-spring-boot-starter/README.md
已删除
100644 → 0
浏览文件 @
3027277c
# 简介
该项目主要利用Spring Boot的自动化配置特性来实现快速的将swagger2引入spring boot应用来生成API文档,简化原生使用swagger2的整合代码。
# 如何使用
dependency引入即可。默认情况下就能产生所有当前Spring MVC加载的请求映射文档。
## 配置示例
```
properties
swagger.enabled
=
true
swagger.title
=
spring-boot-starter-swagger
swagger.description
=
Starter for swagger 2.x
swagger.version
=
1.4.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
=
didi
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.globalOperationParameters[0]
.name
=
name one
swagger.globalOperationParameters[0]
.description
=
some description one
swagger.globalOperationParameters[0]
.modelRef
=
string
swagger.globalOperationParameters[0]
.parameterType
=
header
swagger.globalOperationParameters[0]
.required
=
true
swagger.globalOperationParameters[1]
.name
=
name two
swagger.globalOperationParameters[1]
.description
=
some description two
swagger.globalOperationParameters[1]
.modelRef
=
string
swagger.globalOperationParameters[1]
.parameterType
=
body
swagger.globalOperationParameters[1]
.required
=
false
```
## 配置说明
### 默认配置
```
- swagger.enabled=是否启用swagger,默认:true
- 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规则,默认:空
- swagger.host=文档的host信息,默认:空
- globalOperationParameters用于设置全局的参数,比如:header部分的accessToken等。该参数支持指定docket的配置。
- swagger.globalOperationParameters[0].name=参数名
- swagger.globalOperationParameters[0].description=描述信息
- swagger.globalOperationParameters[0].modelRef=指定参数类型
- swagger.globalOperationParameters[0].parameterType=指定参数存放位置,可选header,query,path,body.form
- swagger.globalOperationParameters[0].required=指定参数是否必传,true,false
```
### Path规则说明
`swagger.base-path`
和
`swagger.exclude-path`
使用ANT规则配置。
我们可以使用
`swagger.base-path`
来指定所有需要生成文档的请求路径基础规则,然后再利用
`swagger.exclude-path`
来剔除部分我们不需要的。
比如,通常我们可以这样设置:
```
properties
management.context-path
=
/ops
swagger.base-path
=
/**
swagger.exclude-path
=
/ops/**, /error
```
上面的设置将解析所有除了
`/ops/`
开始以及spring boot自带
`/error`
请求路径。
其中,
`exclude-path`
可以配合
`management.context-path=/ops`
设置的spring boot actuator的context-path来排除所有监控端点。
### 分组配置
当我们一个项目的API非常多的时候,我们希望对API文档实现分组。从1.2.0.RELEASE开始,将支持分组配置功能。
![
分组功能
](
https://github.com/dyc87112/spring-boot-starter-swagger/blob/master/images/swagger-group.png
)
具体配置内容如下:
```
- swagger.docket.<name>.title=标题
- swagger.docket.<name>.description=描述
- swagger.docket.<name>.version=版本
- swagger.docket.<name>.license=许可证
- swagger.docket.<name>.licenseUrl=许可证URL
- swagger.docket.<name>.termsOfServiceUrl=服务条款URL
- swagger.docket.<name>.contact.name=维护人
- swagger.docket.<name>.contact.url=维护人URL
- swagger.docket.<name>.contact.email=维护人email
- swagger.docket.<name>.base-package=swagger扫描的基础包,默认:全扫描
- swagger.docket.<name>.base-path=需要处理的基础URL规则,默认:/**
- swagger.docket.<name>.exclude-path=需要排除的URL规则,默认:空
- swagger.docket.<name>.name=参数名
- swagger.docket.<name>.modelRef=指定参数类型
- swagger.docket.<name>.parameterType=指定参数存放位置,可选header,query,path,body.form
- swagger.docket.<name>.required=true=指定参数是否必传,true,false
- swagger.docket.<name>.globalOperationParameters[0].name=参数名
- swagger.docket.<name>.globalOperationParameters[0].description=描述信息
- swagger.docket.<name>.globalOperationParameters[0].modelRef=指定参数存放位置,可选header,query,path,body.form
- swagger.docket.<name>.globalOperationParameters[0].parameterType=指定参数是否必传,true,false
```
说明:
`<name>`
为swagger文档的分组名称,同一个项目中可以配置多个分组,用来划分不同的API文档。
**分组配置示例**
```
properties
swagger.docket.aaa.title
=
group-a
swagger.docket.aaa.description
=
Starter for swagger 2.x
swagger.docket.aaa.version
=
1.3.0.RELEASE
swagger.docket.aaa.termsOfServiceUrl
=
https://gitee.com/didispace/spring-boot-starter-swagger
swagger.docket.aaa.contact.name
=
zhaiyongchao
swagger.docket.aaa.contact.url
=
http://spring4all.com/
swagger.docket.aaa.contact.email
=
didi@potatomato.club
swagger.docket.aaa.excludePath
=
/ops/**
swagger.docket.aaa.globalOperationParameters[0]
.name
=
name three
swagger.docket.aaa.globalOperationParameters[0]
.description
=
some description three override
swagger.docket.aaa.globalOperationParameters[0]
.modelRef
=
string
swagger.docket.aaa.globalOperationParameters[0]
.parameterType
=
header
swagger.docket.bbb.title
=
group-bbb
swagger.docket.bbb.basePackage
=
com.yonghui
```
说明:默认配置与分组配置可以一起使用。在分组配置中没有配置的内容将使用默认配置替代,所以默认配置可以作为分组配置公共部分属性的配置。
`swagger.docket.aaa.globalOperationParameters[0].name`
会覆盖同名的全局配置。
\ No newline at end of file
zlt-config/src/main/resources/application-test.properties
浏览文件 @
b3afeeae
...
@@ -14,7 +14,7 @@ zlt.redis.timeout=5000
...
@@ -14,7 +14,7 @@ zlt.redis.timeout=5000
##### elasticsearch配置
##### elasticsearch配置
zlt.elasticsearch.cluster-name
=
my-es
zlt.elasticsearch.cluster-name
=
my-es
zlt.elasticsearch.cluster-nodes
=
120.78.94.191
:9300
zlt.elasticsearch.cluster-nodes
=
47.107.114.25
:9300
##### sentinel配置
##### sentinel配置
zlt.sentinel.dashboard
=
120.78.94.191:6999
zlt.sentinel.dashboard
=
120.78.94.191:6999
\ No newline at end of file
zlt-config/src/main/resources/application.properties
浏览文件 @
b3afeeae
########################## 通用配置 ##########################
########################## 通用配置 ##########################
# 默认开发环境
# 默认开发环境
spring.profiles.active
=
test2
spring.profiles.active
=
dev
##### spring-boot-actuator配置
##### spring-boot-actuator配置
management.endpoints.web.exposure.include
=
*
management.endpoints.web.exposure.include
=
*
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录