npm 包 @svrooij/angular2-swagger-client-generator 使用教程

本文将详细介绍如何使用 npm 包 @svrooij/angular2-swagger-client-generator 生成 Angular 2+ 的 Swagger 客户端。同时还会介绍该工具的深入理解和学习指南，供读者参考。

前置条件

• Node.js （版本 6 或以上）
• Angular CLI （版本 7 或以上）
• Swagger 文件（OpenAPI 3 规范）

安装

首先通过 npm 安装 @svrooij/angular2-swagger-client-generator：

$ npm install -g @svrooij/angular2-swagger-client-generator

同时，你可以将其添加到项目的开发依赖项中：

$ npm install --save-dev @svrooij/angular2-swagger-client-generator

命令行参数

该工具的命令行参数如下：

swagger-client generate [options] <path-to-spec> <output-dir>

其中：

• options：可选参数，用来设定从 swagger 文件生成代码的详细配置。
• path-to-spec：必须参数，swagger 文件的路径。
• output-dir：必须参数，用来说到生成客户端代码的输出目录。

配置

该工具支持多种配置方式，可以通过命令行参数传递，也可以通过单独的配置文件进行配置。下面给出一些常用的配置说明：

• --class-format：定义生成的服务和模型使用的类格式。默认为：kebab-case。
• --service-name：定义服务名称的前缀。默认为：Api。
• --use-static-methods：为生成的 API 代码启用静态方法。默认为：false。
• --with-getter-setter：为生成的模型代码和枚举代码启用 getter 和 setter。默认为：false。
• --model-file-name：定义模型文件名称的格式。默认为：{{modelName}}.model.ts。

使用样例

以下是一个简单的样例：

swagger-client generate -p api -s --model-file-name "{{modelName}}.ts" swagger.json client

其中：

• -p：表示服务名称的前缀为 api。
• -s：启用静态方法。
• --model-file-name "{{modelName}}.ts"：定义模型文件的名称格式。
• swagger.json：swagger 文件的路径。
• client：代码输出目录。

总结

本文介绍了如何通过 npm 包 @svrooij/angular2-swagger-client-generator 生成 Angular 2+ 的 Swagger 客户端代码。同时也介绍了该工具的配置方式和使用样例。希望能帮助读者更加深入地理解该工具，同时提供学习和指导的参考。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005599781e8991b448d72cf