什么是 @azure-tools/codegen
@azure-tools/codegen 是一个 npm 包，它可以根据 Azure REST API 的 OpenAPI 规范自动生成 Typescript 或者 Javascript 的 SDK。这个库使用了一些先进的技术，如自动代码生成、模板引擎等等。它可以将 REST API 转换为易于使用的，自上而下的 SDK，使开发人员可以更轻松地使用 Azure REST API。本文将详细介绍如何使用这个包。
安装
首先，你需要通过以下命令来安装 @azure-tools/codegen
--- ------- -- --------------------
安装完成后，你可以使用以下命令来验证安装是否成功:
--------- ---------
如果你看到了当前版本的输出，最多你已经成功地安装了这个工具。接下来我们将详细讲解如何使用它。
使用
如何生成 Azure REST API 的 SDK
我们首先需要找到 Azure REST API 的 OpenAPI 规范文档，可以在 这里 找到。以 compute-resource-manager 这个规范为例，你可以从中找到以下的 YAML 文件 compute/2019-07-01/:
--- ------------------ --- --- ------------------------ --- --- -------------------------- --- --- ------------------------- --- --- ---------------------------- --- --- -------------------- --- --- ------------------------ --- --- -----------------------------
在 compute/2019-07-01/ 文件夹下有各个资源的规范文件，我们选择其中一个进行测试。以 virtualMachines.json 为例，我们执行以下命令来生成对应的 Typescript 的 SDK:
--------- -------------- --------- ------------ --------------------------------------- --------------- ----------------------
这样就可以在 /path/to/output/folder 目录下生成对应的 SDK。
配置文件配置生成规则
我们也可以使用配置文件 autorest.config.json 来配置不同的生成规则，让生成的 SDK 更加适合自己的项目：
-
---------------- -----------------------
------------- --------------------------------------------
-------- ------ ------- -------- ---------
--------------- ------------
----------------- ---
----------------------- -
-------------------------------
--
-------------------------- ------
---------- --------
------------------------ ----------
---------------- -----------
--------- -
------------ ------------------
--
------------- -
------------ -----
--------------- ------------
---------------- ---------------
-------------------- -----
----------------- ---------- ------------ --- ------ -----------
------------------ --------
----------------------- ---------------------------------
------------------------------ ----
-
-使用示例
我们可以通过以下代码来使用生成的 SDK，以 typescript 版本的为例：
------ - --------------- - ---- ------------------------
------ - ---------- - ---- ---------------
----- ----- - --- ------------ --------- ----------- --------- ---------- ---
----- ------ - --- ---------------------- ------------------------
----- --------- - ----- ---------------------------------
-------------------- ------------
--- ------ -- -- ---------- -
-------------- --------- --------------------------
-在这个示例中，我们使用自动生成的 SDK 客户端 VirtualMachines 来列出 Azure 账户所有的 VM。
总结
使用 @azure-tools/codegen 可以使我们更加方便的使用 Azure 的 REST API。本文中我们介绍了如何安装、使用这个 npm 包，并提供了使用示例。希望这篇文章对你有所启发，让你更加便捷的使用 Azure。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/5f6c3a96a9b7065299ccb931