@@ -86,25 +86,30 @@ swagger.global-response-message.post[0].modelRef=ERROR
8686### 默认配置
8787
8888``` properties
89- - springfox.documentation.enabled =是否启用swagger,默认:true
90- - swagger.title =标题
91- - swagger.description =描述
92- - swagger.version =版本
93- - swagger.license =许可证
94- - swagger.licenseUrl =许可证URL
95- - swagger.termsOfServiceUrl =服务条款URL
96- - swagger.contact.name =维护人
97- - swagger.contact.url =维护人URL
98- - swagger.contact.email =维护人email
99- - swagger.base-package =swagger扫描的基础包,默认:全扫描
100- - swagger.base-path =需要处理的基础URL规则,默认:/**
101- - swagger.exclude-path =需要排除的URL规则,默认:空
102- - swagger.host =文档的host信息,默认:空
103- - swagger.globalOperationParameters[0].name =参数名
104- - swagger.globalOperationParameters[0].description =描述信息
105- - swagger.globalOperationParameters[0].modelRef =指定参数类型
106- - swagger.globalOperationParameters[0].parameterType =指定参数存放位置,可选header,query,path,body.form
107- - swagger.globalOperationParameters[0].required =指定参数是否必传,true,false
89+ springfox.documentation.enabled =是否启用swagger,默认:true
90+ 91+ swagger.title =标题
92+ swagger.description =描述
93+ swagger.version =版本
94+ swagger.license =许可证
95+ swagger.licenseUrl =许可证URL
96+ swagger.termsOfServiceUrl =服务条款URL
97+ 98+ swagger.contact.name =维护人
99+ swagger.contact.url =维护人URL
100+ swagger.contact.email =维护人email
101+ 102+ swagger.base-package =swagger扫描的基础包,默认:全扫描
103+ swagger.base-path =需要处理的基础URL规则,默认:/**
104+ swagger.exclude-path =需要排除的URL规则,默认:空
105+ 106+ swagger.host =文档的host信息,默认:空
107+ 108+ swagger.globalOperationParameters[0].name =参数名
109+ swagger.globalOperationParameters[0].description =描述信息
110+ swagger.globalOperationParameters[0].modelRef =指定参数类型
111+ swagger.globalOperationParameters[0].parameterType =指定参数存放位置,可选header,query,path,body.form
112+ swagger.globalOperationParameters[0].required =指定参数是否必传,true,false
108113```
109114
110115> ` 1.3.0.RELEASE ` 新增:` swagger.host ` 属性,同时也支持指定docket的配置
@@ -145,26 +150,26 @@ swagger.exclude-path=/ops/**, /error
145150具体配置内容如下:
146151
147152``` properties
148- - swagger.docket.<name>.title =标题
149- - swagger.docket.<name>.description =描述
150- - swagger.docket.<name>.version =版本
151- - swagger.docket.<name>.license =许可证
152- - swagger.docket.<name>.licenseUrl =许可证URL
153- - swagger.docket.<name>.termsOfServiceUrl =服务条款URL
154- - swagger.docket.<name>.contact.name =维护人
155- - swagger.docket.<name>.contact.url =维护人URL
156- - swagger.docket.<name>.contact.email =维护人email
157- - swagger.docket.<name>.base-package =swagger扫描的基础包,默认:全扫描
158- - swagger.docket.<name>.base-path =需要处理的基础URL规则,默认:/**
159- - swagger.docket.<name>.exclude-path =需要排除的URL规则,默认:空
160- - swagger.docket.<name>.name =参数名
161- - swagger.docket.<name>.modelRef =指定参数类型
162- - swagger.docket.<name>.parameterType =指定参数存放位置,可选header,query,path,body.form
163- - swagger.docket.<name>.required =true =指定参数是否必传,true,false
164- - swagger.docket.<name>.globalOperationParameters[0].name =参数名
165- - swagger.docket.<name>.globalOperationParameters[0].description =描述信息
166- - swagger.docket.<name>.globalOperationParameters[0].modelRef =指定参数存放位置,可选header,query,path,body.form
167- - swagger.docket.<name>.globalOperationParameters[0].parameterType =指定参数是否必传,true,false
153+ swagger.docket.<name>.title =标题
154+ swagger.docket.<name>.description =描述
155+ swagger.docket.<name>.version =版本
156+ swagger.docket.<name>.license =许可证
157+ swagger.docket.<name>.licenseUrl =许可证URL
158+ swagger.docket.<name>.termsOfServiceUrl =服务条款URL
159+ swagger.docket.<name>.contact.name =维护人
160+ swagger.docket.<name>.contact.url =维护人URL
161+ swagger.docket.<name>.contact.email =维护人email
162+ swagger.docket.<name>.base-package =swagger扫描的基础包,默认:全扫描
163+ swagger.docket.<name>.base-path =需要处理的基础URL规则,默认:/**
164+ swagger.docket.<name>.exclude-path =需要排除的URL规则,默认:空
165+ swagger.docket.<name>.name =参数名
166+ swagger.docket.<name>.modelRef =指定参数类型
167+ swagger.docket.<name>.parameterType =指定参数存放位置,可选header,query,path,body.form
168+ swagger.docket.<name>.required =true =指定参数是否必传,true,false
169+ swagger.docket.<name>.globalOperationParameters[0].name =参数名
170+ swagger.docket.<name>.globalOperationParameters[0].description =描述信息
171+ swagger.docket.<name>.globalOperationParameters[0].modelRef =指定参数存放位置,可选header,query,path,body.form
172+ swagger.docket.<name>.globalOperationParameters[0].parameterType =指定参数是否必传,true,false
168173```
169174
170175说明:` <name> ` 为swagger文档的分组名称,同一个项目中可以配置多个分组,用来划分不同的API文档。
0 commit comments