Skip to content

Commit 36d7d7a

Browse files
committed
fix aop proxy api gen err
1 parent f119141 commit 36d7d7a

File tree

1 file changed

+19
-36
lines changed

1 file changed

+19
-36
lines changed

README.md

Lines changed: 19 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,13 @@
22

33
# 使用过程出现问题,可以提一个issues描述一下,看到后会更正。
44

5-
65
[final版本使用了新的ui库 ](https://github.com/NoBugBoy/YdocLuckyUi)
76

87
```xml
98
<dependency>
109
<groupId>com.github.nobugboy</groupId>
1110
<artifactId>ydoc-spring-boot-starter</artifactId>
12-
<version>1.1.4.final</version>
11+
<version>1.1.5.final</version>
1312
</dependency>
1413
```
1514

@@ -77,41 +76,34 @@ Ydoc是一款基于spring-boot-starter的依赖库,轻量级,不依赖注释
7776
12. 1.1.2新增通用公共headers配置,和解析@RequestHeader注解
7877
12. 1.1.3修复不配置headers会空指针问题,和参数必填显示为false等问题
7978
13. 1.1.4修复requestbody对象内参数使用ParamDesc的required修饰时没有正确的显示在文档上
80-
79+
13. 1.1.5修复代理类无法被正常生成api的问题&代码重构
80+
8181
```xml
8282
<dependency>
8383
<groupId>com.github.nobugboy</groupId>
8484
<artifactId>ydoc-spring-boot-starter</artifactId>
85-
<version>1.1.4</version>
85+
<version>1.1.5</version>
8686
</dependency>
8787
```
88+
8889
final版本是对应正式版本并使用了新的ui库(luck-ui) 建议尝试使用该版本
8990
https://github.com/NoBugBoy/YdocLuckyUi
91+
9092
```xml
9193
<dependency>
9294
<groupId>com.github.nobugboy</groupId>
9395
<artifactId>ydoc-spring-boot-starter</artifactId>
94-
<version>1.1.4.final</version>
96+
<version>1.1.5.final</version>
9597
</dependency>
9698
```
9799

98-
| 配置名 || 是否必须|
99-
|--|--| -- |
100-
| ydoc.token | YApi项目中生成的token ||
101-
| ydoc.host | YApi的url,例http://localhost:3000 ||
102-
| ydoc.headers | 配置所有api公共header参数(多个用,分割)||
103-
|ydoc.enable | 程序启动时是否同步到YApi平台 ||
104-
| ydoc.print | 程序启动时是否打印离线JSON(可手动导入到YApi或其他文档平台) ||
105-
| ydoc.swagger-native |是否启用Swagger原生配置生成文档(方便已经集成了swagger得用户) ||
106-
| ydoc.cloud | 是否开启微服务模式 || | ydoc.autoTest | 是否开启自动化测试 ||
107-
| ydoc.test.name| 自动化测试集合名称,可以多个(自动化测试时使用) ||
108-
| ydoc.id | yapi项目id,在设置中查看(自动化测试时使用) ||
109-
| ydoc.yapi.user.email | yapi登录邮箱(自动化测试时使用) ||
110-
| ydoc.yapi.user.password | yapi登录邮箱密码(自动化测试时使用) ||
111-
| ydoc.accessToken | 钉钉机器人token(自动化测试时使用) ||
112-
| ydoc.email.host |邮件服务器(自动化测试时使用) ||
113-
| ydoc.email.password | 邮箱pop3,smtp密码(自动化测试时使用) ||
114-
| ydoc.email.password | 邮箱pop3,smtp密码(自动化测试时使用)||
100+
| 配置名 || 是否必须| |--|--| -- | | ydoc.token | YApi项目中生成的token || | ydoc.host | YApi的url,例http://localhost:3000 || |
101+
ydoc.headers | 配置所有api公共header参数(多个用,分割)|否| |ydoc.enable | 程序启动时是否同步到YApi平台 |是| | ydoc.print |
102+
程序启动时是否打印离线JSON(可手动导入到YApi或其他文档平台) |否| | ydoc.swagger-native |是否启用Swagger原生配置生成文档(方便已经集成了swagger得用户) |否| | ydoc.cloud |
103+
是否开启微服务模式 |否| | ydoc.autoTest | 是否开启自动化测试 |否| | ydoc.test.name| 自动化测试集合名称,可以多个(自动化测试时使用) |否| | ydoc.id |
104+
yapi项目id,在设置中查看(自动化测试时使用) |否| | ydoc.yapi.user.email | yapi登录邮箱(自动化测试时使用) |否| | ydoc.yapi.user.password | yapi登录邮箱密码(
105+
自动化测试时使用) |否| | ydoc.accessToken | 钉钉机器人token(自动化测试时使用) |否| | ydoc.email.host |邮件服务器(自动化测试时使用) |否| | ydoc.email.password
106+
| 邮箱pop3,smtp密码(自动化测试时使用) || | ydoc.email.password | 邮箱pop3,smtp密码(自动化测试时使用)||
115107

116108
注意当开启了swagger-native,需要将原工程的swagger依赖删除即可。(YDoc内部使用swagger3.0)
117109

@@ -150,22 +142,13 @@ https://github.com/NoBugBoy/YdocLuckyUi
150142

151143
抛弃大量Swagger注解和配置,仅需在SpringBootWeb开发时必须注解上加额外参数对api或参数进行描述,大大减少了对工程的侵入性,简化开发流程
152144

153-
| 注解 ||
154-
|--|--|
155-
| @RestController | 注解中value描述controller的作用,默认为controller名 |
156-
| @RequestMapping|注解中name描述该api的作用,在类上加跟路径时不需要name |
157-
| @PathVariable|注解中name描述该参数的作用 |
158-
| @GetMapping | 注解中name描述该api的作用 |
159-
| @PostMapping |注解中name描述该api的作用 |
160-
| @DeleteMapping | 注解中name描述该api的作用 |
161-
| @PutMapping | 注解中name描述该api的作用 |
162-
| @RequestHeader | 注解中name描述该api的作用 |
145+
| 注解 || |--|--| | @RestController | 注解中value描述controller的作用,默认为controller名 | |
146+
@RequestMapping|注解中name描述该api的作用,在类上加跟路径时不需要name | | @PathVariable|注解中name描述该参数的作用 | | @GetMapping | 注解中name描述该api的作用 |
147+
| @PostMapping |注解中name描述该api的作用 | | @DeleteMapping | 注解中name描述该api的作用 | | @PutMapping | 注解中name描述该api的作用 | |
148+
@RequestHeader | 注解中name描述该api的作用 |
163149

164150
@ParamDesc@ParamIgnore为YDoc额外的自有注解,其余为SpringBoot的注解,@ParamDesc用来标识实体中参数的描述,@ParamIgnore用来忽略参数不参与生成文档,如不加参数描述则默认为参数的名称。
165-
| 注解 ||
166-
|--|--|
167-
| @ParamDesc| 注解中value描述该参数的描述,required是否必须 |
168-
| @ParamIgnore| 忽略参数 |
151+
| 注解 || |--|--| | @ParamDesc| 注解中value描述该参数的描述,required是否必须 | | @ParamIgnore| 忽略参数 |
169152

170153
### 6. Enum类型
171154

0 commit comments

Comments
 (0)