如何用openapi-generator在现有Angular项目中生成模块而非独立包

一、直接通过生成器配置实现 #

完全可以通过调整生成器参数，让代码直接生成到现有Angular项目里，无需生成独立npm包。关键配置项和示例命令如下：

• 指定项目内输出目录：用-o参数设置现有项目中的目标路径，比如./src/app/api-modules/user-api，生成的所有代码会直接写入该目录。
• 跳过独立包相关文件：通过additional-properties设置skipPackageJson=true、skipGitignore=true、skipReadme=true，避免生成独立包专属的配置文件。
• 对齐项目Angular版本：设置ngVersion为你现有项目的版本号，确保生成的代码与项目依赖兼容。
• 自定义模块前缀：用apiModulePrefix设置符合项目命名规范的模块前缀，保持代码风格统一。

示例命令：

openapi-generator-cli generate \
  -i ./path/to/your-openapi-spec.yaml \
  -g typescript-angular \
  -o ./src/app/api-modules/user-api \
  --additional-properties ngVersion=16.0.0,skipPackageJson=true,skipGitignore=true,skipReadme=true,apiModulePrefix=User

二、已生成独立包的手动整合步骤 #

如果已经生成了独立npm包，也可以手动迁移到现有项目，步骤如下：

1. 复制核心代码
   把生成包内src/lib下的所有文件（模块、服务、模型、拦截器等）复制到现有项目的目标目录，比如src/app/api-modules/user-api。

2. 修正导入路径
   批量替换生成代码中的相对导入路径，确保和现有项目的目录结构匹配。如果项目用了路径别名，也可以改成别名格式（比如把./models/user改成@app/api-modules/user-api/models/user）。

3. 舍弃独立包配置文件
   不要复制生成包的package.json、tsconfig.json、README.md、.gitignore这些文件，现有项目的配置完全够用。

4. 在项目中引入API模块
   在需要使用该API的模块（比如根模块AppModule或者功能模块）中导入并声明生成的API模块：

   // src/app/app.module.ts
   import { UserApiModule } from './api-modules/user-api/user-api.module';
   
   @NgModule({
     imports: [
       // ...其他已导入模块
       UserApiModule
     ]
   })
   export class AppModule { }
   

5. 解决依赖版本问题
   检查生成代码依赖的rxjs、@angular/*等包的版本是否和现有项目一致。如果不一致，要么调整项目依赖版本，要么重新用匹配的ngVersion参数生成代码。

6. 验证编译运行
   执行ng build和ng serve，排查并修复可能出现的编译错误（比如路径错误、类型不兼容等）。

内容的提问来源于stack exchange，提问作者g.pickardou