Swagger自动生成OpenApi文档

一、文档编写

1.UI界面 前往swaggerHub官网进行编写,注册即可

2.选择自己的项目 例如:itsm-open_api

3.支持json和yaml格式进行书写接口,推荐yaml格式,非常的方便,谁用谁知道

4.编写无错误之后右上角下载按钮下载为yaml格式文件

5.为了防止html会有中文乱码、格式错乱等问题,故将导出的yaml文件放进swagger工程中,用idea打包后取html文件夹中的html文件。

注意事项:

即使从idea打完包取出来的html也是存在部分乱码情况,因为windows默认编码GBK,生成的html的编码格式为utf-8,因此会产生乱码问题。使用linux或者用IDE强制项目使用utf8编码即可。

 Windows环境下需要修改环境变量,让JVM使用utf8编码。添加环境变量 JAVA_TOOL_OPTIONS=-Dfile.encoding=UTF8。修改成功后再次运行mvn package会看到控制台会额外打印一行信息: Picked up JAVA_TOOL_OPTIONS: -Dfile.encoding=UTF8 生成的html就不会乱码了。


评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

清茶_

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值