文章目录- 问题描述
- 生成的swagger文档出现部分乱码:
- 生成的swagger文档出现部分乱码:
- 解决办法
- swagger文档设置自动同步到yapi
问题描述
生成的swagger文档出现部分乱码:
解决办法
原因:编码格式错误。 cmd打开命令窗口,运行如下命令:
代码语言:javascript复制mvn -v
查看maven配置内容,Platform encoding为编码格式,若编码格式不对则修改maven编码格式,查看到当前的编码格式为GBK。
设置环境变量,变量名MAVEN_OPTS
,变量值 -Xms256m -Xmx512m -Dfile.encoding=UTF-8
,把编码格式设置成UTF-8,保存后重新执行mvn -v
,可以看到编码格式已经调整成UTF-8。
把对应的工程文件重新编译后启动,再次访问swagger文档可以正常显示。
swagger文档设置自动同步到yapi
SpringBoot项目引入swagger文档后,每次都要手工维护接口到YApi很麻烦,有没有设置自动化同步的办法?操作如下: 进入YApi后添加项目
添加完项目后,点击设置,配置基本项目信息,由于我这边走的是网关,所以接口基本路径设置了一个 /api的统一前缀。
设置完基本信息后,可以在环境配置里面设置不同环境的请求地址和请求头信息等
在swagger自动同步中设置要同步的信息 开启自动同步-》设置同步方式-》项目的swagger json地址(配置为项目的请求接口地址 /v2/api-docs)-》设置多久同步一次,我这边设置的是2分钟。
配置完毕后可以在动态中查看到接口自动同步的相关信息
如有收获欢迎点赞