1.4.0 增加全局参数配置 #16
Merged
1.4.0 增加全局参数配置 #16
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dyc87112
reviewed
Sep 1, 2017
README.md
Outdated
| - swagger.docket.<name>.name=参数名 | ||
| - swagger.docket.<name>.modelRef=指定参数类型 | ||
| - swagger.docket.<name>.parameterType=指定参数存放位置,可选header,query,path,body.form | ||
| - swagger.docket.<name>.required=true=指定参数是否必传，true,false | ||
| ``` |
There was a problem hiding this comment.
swagger.docket..required=指定参数是否必传，true,false
dyc87112
reviewed
Sep 1, 2017
| .modelRef(new ModelRef(swaggerProperties.getModelRef())) | ||
| .parameterType(swaggerProperties.getParameterType()) | ||
| .required(Boolean.parseBoolean(swaggerProperties.getRequired())) | ||
| .build())) | ||
| .groupName(groupName) |
README.md
Outdated
| - swagger.docket.<name>.name=参数名 | ||
| - swagger.docket.<name>.modelRef=指定参数类型 | ||
| - swagger.docket.<name>.parameterType=指定参数存放位置,可选header,query,path,body.form | ||
| - swagger.docket.<name>.required=true=指定参数是否必传，true,false | ||
| ``` |
There was a problem hiding this comment.
参数的设计由于全局操作参数也算是一个小类，建议以swagger.global-operation-params.xxx的方式构建，这样更加清晰，不然都跟docket的info信息混淆。
dyc87112
reviewed
Sep 3, 2017
|
|
||
| @Data | ||
| @NoArgsConstructor | ||
| @ConfigurationProperties("swagger.globalOperationParameters") |
There was a problem hiding this comment.
@ConfigurationProperties("swagger.globalOperationParameters") 这个不加应该也可以
| excludePath.add(PathSelectors.ant(path)); | ||
| } | ||
|
|
||
| Docket docket = new Docket(DocumentationType.SWAGGER_2) | ||
| .host(swaggerProperties.getHost()) | ||
| .apiInfo(apiInfo) | ||
| .globalOperationParameters(buildGlobalOperationParametersFromSwaggerProperties(swaggerProperties)) |
There was a problem hiding this comment.
所有docket都一样配置？
建议除了全局配置之外，每个docket应该也可以配置覆盖全局配置。
| - swagger.docket.<name>.name=参数名 | ||
| - swagger.docket.<name>.modelRef=指定参数类型 | ||
| - swagger.docket.<name>.parameterType=指定参数存放位置,可选header,query,path,body.form | ||
| - swagger.docket.<name>.required=true=指定参数是否必传，true,false |
There was a problem hiding this comment.
swagger.docket..required=指定参数是否必传，true,false
去掉多余的内容
| @@ -129,6 +144,10 @@ swagger.exclude-path=/ops/**, /error | |||
| - swagger.docket.<name>.base-package=swagger扫描的基础包，默认：全扫描 | |||
| - swagger.docket.<name>.base-path=需要处理的基础URL规则，默认：/** | |||
| - swagger.docket.<name>.exclude-path=需要排除的URL规则，默认：空 | |||
| - swagger.docket.<name>.name=参数名 | |||
README.md
Outdated
| - swagger.globalOperationParameters[0].description=描述信息 | ||
| - swagger.globalOperationParameters[0].modelRef=指定参数类型 | ||
| - swagger.globalOperationParameters[0].parameterType=指定参数存放位置,可选header,query,path,body.form | ||
| - swagger.globalOperationParameters[0].required=指定参数是否必传，true,false | ||
| ``` | ||
|
|
||
| > host属性从1.3.0.RELEASE开始支持 |
There was a problem hiding this comment.
增加 globalOperationParameters支持的说明，从1.4.0.RELEASE开始
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.