ydoc-spring-boot-starter-1.0.7版本

最新推荐文章于 2024-07-04 15:44:38 发布

如果悲伤有颜色，那么一定是黄昏

最新推荐文章于 2024-07-04 15:44:38 发布

阅读量47

点赞数

本文链接：https://blog.csdn.net/Day_Day_No_Bug/article/details/132974696

版权

theme: jzman

这是我参与8月更文挑战的第4天，活动详情查看：8月更文挑战

ydoc-spring-boot-starter-1.0.7版本升级

坚持初心，做自己想做的。

欢迎各位小伙伴尝试使用，有建议或问题可以提到这里issues，欢迎志同道合的朋友一起贡献代码，让api文档更加简单，减少对业务的侵入提高工作效率,未来希望在兼容主流的swagger和yapi格式的同时，能够有一套自己的ui,和更多定制化、插件化的功能。

使用规范建议： 1. 无论是什么请求，如果使用对象接收对象内的基本类型建议使用包装类 2. 建议在参数上加@ParamDesc用来描述作用 3. spring提供的注解再原有开发习惯上加name，用来描述RestController或Api的作用 4. 如有特殊参数例如Bindingresult，登录的用户实体等使用@ParamIgnore进行忽略 5. 尽量避免相同对象嵌套的蜜汁行为,避免文档生成缺少参数(swagger会这样) 6. 使用YApi时注意风险防范，有被攻击的可能(有机房，部署在内网最合适不过)

1.0.7版本修复如下缺陷： 1. 无法生成带有匿名内部类参数的接口文档 2. 修复嵌套相同实体类问题,尽量与原生保存一致 3. 修复部分参数类型不准确的问题 4. 修复如果不想使用Swagger只想使用YApi但是不添加@EnableSwagger2注解会报错的问题 5. 代码格式优化 6. 修复api文档@RequestMapping必须由'/'开头才能生成的问题 7. 加入apache2.0开源协议

maven依赖 <dependency> <groupId>com.github.nobugboy</groupId> <artifactId>ydoc-spring-boot-starter</artifactId> <version>1.0.7</version> </dependency>