使用 swagger 4.x 软件包生成 swagger 2.0 yaml

Question

我要将我的API服务器集成到Google Cloud Endpoints。

截至目前，Google Cloud Endpoints支持swagger 2.0。

但是我的依赖项/库现在是最新版本。所以我想在不降级 swagger 库版本的情况下生成 swagger 2.0 yaml 文件(api端点已经用 swagger 4.x - openapi 3.0 规范进行了描述(。

Nestjs 和 swagger dependencies (package.json(：

...
"@nestjs/common": "^7.0.0",
"@nestjs/config": "^0.4.0",
"@nestjs/core": "^7.0.0",
"@nestjs/platform-express": "^7.0.0",
"js-yaml": "^3.14.0",
...
"@nestjs/swagger": "^4.5.4",
"swagger-ui-express": "^4.1.4",
...

和招摇的生成器脚本：

import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
import * as fs from 'fs'
import * as yaml from 'js-yaml'
const generateSwaggerYaml = async () => {
const app = await NestFactory.create(AppModule);
const options = new DocumentBuilder()
.setTitle('API Title')
.setDescription('API Description')
.build()
const document = SwaggerModule.createDocument(app, options)
fs.writeFileSync("./openapi-run.yaml", yaml.safeDump(document))
}

generateSwaggerYaml()

脚本的输出是openapi 3.0规范:(

openapi: 3.0.0
info:
title: API Title
description: API Description.
version: 1.0.0
contact: {}
tags: []
servers: []
...

是否有任何选项/方法可以从openapi 3.0文档生成swagger2.0 yaml？

如何将 openapi 3.0 规范降级为招摇 2.0 规范？

Answer 1

我从github使用这个项目来实现这个目的：https://github.com/LucyBot-Inc/api-spec-converter

对于openapi 3 yaml来说，大摇大摆2 yaml，就像$ api-spec-converter --from openapi_3 --syntax yaml --to swagger_2 ${f} > ${SWAGGER_V2_FILE}一样简单