近年来，随着前端技术的飞速发展，前端的工作范畴越来越广泛，需要使用的工具也越来越多。为了提高效率并减少工作中的不必要的麻烦，npm 的出现为前端开发人员带来了便利。本文将重点介绍使用 npm 包 @openapis/codegen-cli-js 生成 API 的方式及相关细节。
什么是 @openapis/codegen-cli-js？
@openapis/codegen-cli-js 是一款基于 JavaScript 语言的 npm 包，主要功能是通过 OpenAPI 规范生成 API 相关的文件。它支持生成多种语言的文件，如 HTML、JS、typescript 等，并支持多个操作系统，并可以在命令行中使用。
如何安装 @openapis/codegen-cli-js？
要使用 @openapis/codegen-cli-js，必须先安装它。安装需要先安装 Node.js 和 npm。在命令行中输入以下命令：
npm install -g @openapis/codegen-cli-js
其中 -g 表示将包全局安装，这样就可以在任何文件夹中使用 openapi-generator-cli 命令了。
如何使用 @openapis/codegen-cli-js 生成 API？
接下来，我们将重点介绍如何使用 @openapis/codegen-cli-js 生成 API 的代码。首先，我们需要准备一个 OpenAPI 规范文件。在本文中，我们将以 petstore.yaml 规范文件作为生成的样例示范。
生成 HTML 版本的 API 文件
在命令行中输入以下代码：
openapi-generator-cli generate -i petstore.yaml -g html2 -o petstore-html
其中：
-i表示要生成 API 的规范文件路径；-g表示要生成的文件类型，这里是 HTML 版本；-o表示生成的文件输出路径。
生成的 API 文件将会出现在 petstore-html 的文件夹中。
生成 TypeScript 文件的 API 文件
在命令行中输入以下代码：
openapi-generator-cli generate -i petstore.yaml -g typescript-fetch -o petstore-ts
其中：
-i表示要生成 API 的规范文件路径；-g表示要生成的文件类型，这里是 TypeScript 版本；-o表示生成的文件输出路径。
生成的 API 文件将会出现在 petstore-ts 的文件夹中。
总结
本文介绍了 npm 包 @openapis/codegen-cli-js 的使用方法和相关内容。通过本文的学习，您已经学会了如何安装并使用 @openapis/codegen-cli-js 生成 API 的方法，这将大大简化您的工作效率，并提高工作的质量，有助于您在前端开发中更加高效的工作。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055b0c81e8991b448d8b2a