如何使用swagger 3.x从源注释生成OAS yaml文件？

要使用Swagger 3.x（OpenAPI Specification 3.x）从源代码注释生成OAS YAML文件，您可以使用Swagger Codegen或OpenAPI Generator

以下是如何使用这两种方法的基本步骤：

使用Swagger Codegen：

1. 首先，确保你已经安装了Java运行时环境（JRE），因为Swagger Codegen是一个Java程序。
2. 下载Swagger Codegen的JAR文件。前往Swagger Codegen的GitHub发布页面（https://github.com/swagger-api/swagger-codegen/releases）下载最新的发布版本。
3. 将你的源代码注释与Swagger注解一起编写。为此，请遵循Swagger 3.x注解规范。
4. 打开命令行终端，使用以下格式的命令生成OAS YAML文件：

java -jar /path/to/swagger-codegen-cli.jar generate -i /path/to/input.yaml(or .json) -l swagger -o /path/to/output

其中：

• /path/to/swagger-codegen-cli.jar 是Swagger Codegen JAR文件的路径（步骤2下载的文件）。
• /path/to/input.yaml(or .json) 是Swagger API文档输入文件（JSON或YAML格式）。在线代码注释可以通过工具如swaggo/swag 或者 go-swagger 自动生成。
• -l swagger 表示要生成的输出文件的语言是Swagger（OpenAPI）。
• /path/to/output 是生成的OAS YAML文件保存的目录。

1. 运行命令后，您的OAS YAML文件将生成并保存到指定的输出目录。

使用OpenAPI Generator：

1. 确保你已经安装了Java运行时环境（JRE），因为OpenAPI Generator也是一个Java程序。
2. 安装OpenAPI Generator。可以通过以下命令安装OpenAPI Generator：

npm install @openapitools/openapi-generator-cli -g

1. 在你的项目中编写Swagger 3.x注释。确保遵循OpenAPI 3.x规范。
2. 使用以下命令生成OAS YAML文件：

openapi-generator generate -i /path/to/input.yaml(or .json) -g openapi -o /path/to/output

其中：

• /path/to/input.yaml(or .json) 是OpenAPI API文档输入文件（JSON或YAML格式）。在线代码注释可以通过工具如swaggo/swag 或者 go-swagger 自动生成。
• -g openapi 表示要生成的输出文件的语言是OpenAPI。
• /path/to/output 是生成的OAS YAML文件保存的目录。

1. 运行命令后，您的OAS YAML文件将生成并保存到指定的输出目录。