Skip to content

Commit a6753bf

Browse files
committed
update 3.0.0支持
1. 实现ApiInfo的配置 2. 实现host的配置 3. 实现根据包扫描选择接口生成文档 4. 实现ignoredParameterTypes的配置 5. 实现securitySchemes的配置 未实现内容: 1. 实现根据path规则选择接口生成文档 2. 实现全局Request参数的配置 3. 实现全局Response参数的配置
1 parent e58d172 commit a6753bf

File tree

2 files changed

+9
-63
lines changed

2 files changed

+9
-63
lines changed

src/main/java/com/spring4all/swagger/DocketConfiguration.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,11 @@ public Docket createRestApi() {
4343
builder.securitySchemes(Collections.singletonList(swaggerAuthorizationConfiguration.apiKey()));
4444
}
4545

46+
// 要忽略的参数类型
47+
Class<?>[] array = new Class[swaggerProperties.getIgnoredParameterTypes().size()];
48+
Class<?>[] ignoredParameterTypes = swaggerProperties.getIgnoredParameterTypes().toArray(array);
49+
builder.ignoredParameterTypes(ignoredParameterTypes);
50+
4651
// 需要生成文档的接口目标配置
4752
Docket docket = builder.select()
4853
.apis(RequestHandlerSelectors.basePackage(swaggerProperties.getBasePackage())) // 通过扫描包选择接口

src/main/java/com/spring4all/swagger/SwaggerProperties.java

Lines changed: 4 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,7 @@
55
import org.springframework.boot.context.properties.ConfigurationProperties;
66

77
import java.util.ArrayList;
8-
import java.util.LinkedHashMap;
98
import java.util.List;
10-
import java.util.Map;
119

1210
/**
1311
* @author 翟永超
@@ -64,11 +62,6 @@ public class SwaggerProperties {
6462
**/
6563
private List<String> excludePath = new ArrayList<>();
6664

67-
/**
68-
* 分组文档
69-
**/
70-
private Map<String, DocketInfo> docket = new LinkedHashMap<>();
71-
7265
/**
7366
* host信息
7467
**/
@@ -119,60 +112,6 @@ public static class GlobalOperationParameter {
119112

120113
}
121114

122-
@Data
123-
@NoArgsConstructor
124-
public static class DocketInfo {
125-
126-
/**
127-
* 标题
128-
**/
129-
private String title = "";
130-
/**
131-
* 描述
132-
**/
133-
private String description = "";
134-
/**
135-
* 版本
136-
**/
137-
private String version = "";
138-
/**
139-
* 许可证
140-
**/
141-
private String license = "";
142-
/**
143-
* 许可证URL
144-
**/
145-
private String licenseUrl = "";
146-
/**
147-
* 服务条款URL
148-
**/
149-
private String termsOfServiceUrl = "";
150-
151-
private Contact contact = new Contact();
152-
153-
/**
154-
* swagger会解析的包路径
155-
**/
156-
private String basePackage = "";
157-
158-
/**
159-
* swagger会解析的url规则
160-
**/
161-
private List<String> basePath = new ArrayList<>();
162-
/**
163-
* 在basePath基础上需要排除的url规则
164-
**/
165-
private List<String> excludePath = new ArrayList<>();
166-
167-
private List<GlobalOperationParameter> globalOperationParameters;
168-
169-
/**
170-
* 忽略的参数类型
171-
**/
172-
private List<Class<?>> ignoredParameterTypes = new ArrayList<>();
173-
174-
}
175-
176115
@Data
177116
@NoArgsConstructor
178117
public static class Contact {
@@ -245,12 +184,14 @@ public static class GlobalResponseMessageBody {
245184
/**
246185
* 响应码
247186
**/
248-
private int code;
187+
private String code;
249188

250189
/**
251190
* 响应消息
252191
**/
253-
private String message;
192+
private String description;
193+
194+
private String representation;
254195

255196
/**
256197
* 响应体

0 commit comments

Comments
 (0)