Skip to content

Commit

Permalink
release 2.2.3
Browse files Browse the repository at this point in the history
  • Loading branch information
shalousun committed Jul 18, 2021
1 parent bf3fceb commit cf930cc
Show file tree
Hide file tree
Showing 4 changed files with 51 additions and 4 deletions.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,30 @@ When you need to use smart-doc to generate more API document information, you ca
"desc": "desc",
"required": false,
"since": "-"
}]
}],
"requestParams": [ //Public request parameters (a scenario where public request parameters are processed through interceptors) ,@since 2.2.3,no need to set
{
"name": "configPathParam",
"type": "string",
"desc": "desc",
"paramIn": "path", // path,query
"value":"testPath",//default is null
"required": false,
"since": "-",
"pathPatterns": "*",
"excludePathPatterns":"/app/page/**"
},{
"name": "configQueryParam",
"type": "string",
"desc": "desc",
"paramIn": "query",
"value":"testQuery",
"required": false,
"since": "-",
"pathPatterns": "*",
"excludePathPatterns":"/app/page/**"
}
]
}
```
**Note:** The above json configuration is completely converted into json using the smart-doc's ApiConfig.
Expand Down
23 changes: 23 additions & 0 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,29 @@ https://gitee.com/devin-alan/smart-doc-gradle-plugin-demo
"required": false,
"since": "-"
}],
"requestParams": [ //公共请求参数(通过拦截器处理的场景),@since 2.2.3,没有需求请不要设置
{
"name": "configPathParam",//请求头名称
"type": "string",//请求头类型
"desc": "desc",//请求头描述信息
"paramIn": "path",
"value":"testPath",//不设置默认null
"required": false,//是否必须
"since": "-",//什么版本添加的改请求头
"pathPatterns": "*",//正则表达式过滤请求头
"excludePathPatterns":"/app/page/**" //参考请求头中的用法
},{
"name": "configQueryParam",//请求头名称
"type": "string",//请求头类型
"desc": "desc",//请求头描述信息
"paramIn": "query",
"value":"testQuery",//不设置默认null
"required": false,//是否必须
"since": "-",//什么版本添加的改请求头
"pathPatterns": "*",//正则表达式过滤请求头
"excludePathPatterns":"/app/page/**"
}
],
"apiConstants": [{//从1.8.9开始配置自己的常量类,smart-doc在解析到常量时自动替换为具体的值。非必须,根据自己需求来设置
"constantsClassName": "com.power.doc.constants.RequestParamConstant"//项目自己定义的常量
}],
Expand Down
6 changes: 3 additions & 3 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ plugins {
}

group 'com.github.shalousun'
version '2.2.2'
version '2.2.3'

sourceCompatibility = 1.8

Expand All @@ -34,7 +34,7 @@ repositories {

dependencies {
testImplementation group: 'junit', name: 'junit', version: '4.13.2'
implementation group: 'com.github.shalousun', name: 'smart-doc', version: '2.2.2'
implementation group: 'com.github.shalousun', name: 'smart-doc', version: '2.2.3'
}
tasks.withType(JavaCompile) {
options.encoding = "UTF-8"
Expand All @@ -55,7 +55,7 @@ artifacts {
}

signing {
sign publishing.publications.mavenJava
sign configurations.archives
}

gradlePlugin {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ public boolean ignoreArtifactById(CustomArtifact artifact) {
case "spring-boot-starter-logging":
case "spring-boot-starter-tomcat":
case "spring-cloud-starter-openfeign":
case "spring-cloud-starter":
return true;
default:
return this.ignore(filterChain, artifact);
Expand Down

0 comments on commit cf930cc

Please sign in to comment.