在NestJS中将Swagger文档生成为JSON / YAML

Question

我已按照说明创建了Swagger文档，现在可以通过Swagger UI使用我的文档。我还想将文档生成为JSON或YAML，以便在Postman等中轻松导入，但是我在中找不到任何合适的方法，SwaggerModule而Swagger UI也没有任何导出按钮。

Answer 1

在Nestjs v9中测试

假设docs路径如下

http://localhost:3000/docs

获取 JSON

http://localhost:3000/docs-json

获取 YAML

http://localhost:3000/docs-yaml

Answer 2

尝试访问/api/json而不是/api-json遵循https://docs.nestjs.com/recipes/swagger。

Answer 3

根据这个github问题，您可以将创建的Swagger字符串化document，例如将其写入文件系统，如下所示：

const app = await NestFactory.create(ApplicationModule);
const options = new DocumentBuilder()
    .setTitle("Title")
    .setDescription("description")
    .setVersion("1.0")
    .build();
const document = SwaggerModule.createDocument(app, options);

fs.writeFileSync("./swagger-spec.json", JSON.stringify(document));
SwaggerModule.setup("/api", app, document);

await app.listen(80);