theme: channing-cyan
第一次录制B站视频,讲解自己的开源项目
录制视频使用QuickTimePlayer,剪辑使用Imovie
视频中使用1.0.5版本是未修复的,需要使用1.0.6稳定版本
如果只想使用YApi不使用swagger可不加@EnableSwagger2注解配置即可
Ydoc替代Swagger的文档生成器
目前所支持的全部参数
| 配置名 | 值 | 是否必须| |--|--| -- | | ydoc.token | YApi项目中生成的token |否| | ydoc.host | YApi的url,例http://localhost:3000 |否| | ydoc.enable | 程序启动时是否同步到YApi平台 |是| | ydoc.print | 程序启动时是否打印离线JSON(可手动导入到YApi或其他文档平台) |否| | ydoc.swagger-native | 是否启用Swagger原生配置生成文档(方便已经集成了swagger得用户) |否| | ydoc.cloud | 是否开启微服务模式(自动合并) |否| | ydoc.autoTest | 是否开启自动化测试 |否| | ydoc.test.name | 自动化测试集合名称,可以多个(自动化测试时使用) |否| | ydoc.id | yapi项目id,在设置中查看(自动化测试时使用) |否| | ydoc.yapi.user.email | yapi登录邮箱(自动化测试时使用) |否| | ydoc.yapi.user.password | yapi登录邮箱密码(自动化测试时使用) |否| | ydoc.accessToken | 钉钉机器人token(自动化测试时使用) |否| | ydoc.email.host | 邮件服务器(自动化测试时使用) |否| | ydoc.email.password | 邮箱pop3,smtp密码(自动化测试时使用) |否| | ydoc.to.emails | 接受邮件的邮箱,可以多个 |否|
注意当开启了swagger-native,需要将原工程的swagger依赖删除即可。(YDoc内部使用swagger3.0)
YApi的使用步骤(导入YApi,YDoc方式或者原生swagger都支持)
- 在搭建好的YApi平台上创建好对应工程的项目
- 点开项目,设置-token配置,复制好token粘贴到Java工程的对应配置上
- 配置ydoc.enable = true,yapi-host,yapi-token
- 启动应用即可
- 回到YApi页面,文档生产完毕
Swaager3的使用步骤(YDoc生成方式)
- 开启@EnableSwagger2
- 使用YDoc注解生成方式配置项目
- 配置ydoc.enable = true
- 启动应用访问 /doc.html
原生Swaager的使用(方便已经使用原生swagger注解的项目)
- 和普通swagger一样配置即可,需要配置扫包和swagger注解等
- 配置ydoc.enable = true,swagger-native=true
- 启动应用访问 /doc.html
自动化测试的使用
- 配置测试集合,并定义名称(英文)
- 配置ydoc.autoTest=true,ydoc.id,ydoc.test.name
- 启动应用自动开始测试(异步)
- 测试结束发送报告,参考下面的文章链接
1.0.5非原生模式也支持swagger页面,邮件推送web页面展示
录制过程
录制是需要录制整个屏幕,本来是准备用语言方式讲解的,后来不清楚什么原因发现有噪音,就先录制了视频,后期追加音乐的方式制作,当录制出现问题时其实是要重新录制否则就会有太多的剪辑痕迹,我这里其实录制了三段视频外加一段音轨,进行合并剪辑,并在适合的地方添加文字描述。总体来讲还是比较简单的,不需要看教程,工具也很简单,对剪辑小白很友好呀。