Swagger-Codegen:如何将所有文件合并到一个文件中以进行客户端代码生成

Question

我刚刚开始使用Swagger和NodeJS.我能够将Swagger实现到我的NodeExpress应用程序,并且能够准确地生成带有Swagger-Codegen(Typescript-Angular)的typescript-client-code.

我遇到的一个问题是生成的代码分散了很多不同的文件.我希望它只输出一个文件api.ts,它包含API调用和接口/模型的所有内容.

我一直在寻找解决这个问题的方法,因为随着后端的增长,很难读取和维护生成的客户端代码.

任何建议或指示将不胜感激.

节日快乐!谢谢

编辑:我一直在寻找这个问题的答案,但仍然没有找到答案.我目前正在开发一个使用ASP.NET Core的项目,他们可以NSwag实现我想要实现的目标Node Swagger.

Answer 1

TL; DR

你可以编译所有的文件到一个单一的*.ts文件显示,在这篇文章.

持续集成方法

Swagger代码生成器简化了维护,因为它允许您根据连续集成进行思考.

你不应该担心代码审查或美学(因为它是一个机器生成的代码),但是关于:

• API版本控制
• 函数,方法和类签名
• 文档

如果您正在使用诸如Jenkins或Ansible之类的CI系统,则可以自动将库部署到私有NPM帐户(用于JS和TS)或Maven服务器(用于Java和Kotlin).

保持程序包版本号不断更新将允许IDE正确地提示用户有关API的更新.