Swagger自动生成OpenApi文档

一、文档编写

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

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

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

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

Swagger自动生成OpenApi文档

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就不会乱码了。