如何使用NX生成OpenAPI JSON？

发布于 2025-02-12 02:26:10 字数 877 浏览 0 评论 0原文

我有 nestjs 在monorepo和 nx 是我们的构建系统。

我正在寻找一种在构建时间编译和运行TS文件的方法。 TS文件具有生成OpenApi.json文件的逻辑。 TS文件从项目中的main.js和其他文件导入函数。

代码：

  
  const options = new DocumentBuilder()
    .setTitle('Cats example')
    .setDescription('The cats API description')
    .setVersion('1.0')
    .addTag('cats')
    .build();
  const document = SwaggerModule.createDocument(app, options);
  const outputPath = path.resolve(process.cwd(), 'swagger.json');
  writeFileSync(outputPath, JSON.stringify(document), { encoding: 'utf8'});

  await app.close();

问题：由于NX生成了一个文件main.js。如何编译和运行我的TS文件？

PS如果我将其放入main.js的bootstrap方法中，则相同的代码可以正常工作，但这是我不想要的。

原文

I am having NestJS projects in a Monorepo and NX is our build system.

I am looking for a way to compile and run a TS file at build time. The TS file has a logic to generate openapi.json file. TS file imports functions from main.js and other files in the project.

Code:

  
  const options = new DocumentBuilder()
    .setTitle('Cats example')
    .setDescription('The cats API description')
    .setVersion('1.0')
    .addTag('cats')
    .build();
  const document = SwaggerModule.createDocument(app, options);
  const outputPath = path.resolve(process.cwd(), 'swagger.json');
  writeFileSync(outputPath, JSON.stringify(document), { encoding: 'utf8'});

  await app.close();

Issue: Since the NX generates a single file main.js. How I can compile and run my TS file?

P.S the same code works if I put it in bootstrap method of main.js but that is something I don't want.

分享到QQ

分享到微博