本文将介绍如何使用 npm 包 @microsoft.azure/openapi 来生成 RESTful API 的客户端库。这个包可以帮助我们快速生成请求和响应模型、API 调用方法和错误模型等。
什么是 OpenAPI？
OpenAPI 是一种描述 RESTful API 的标准格式。它可以用于生成客户端库，便于调用 API。
什么是 @microsoft.azure/openapi？
@microsoft.azure/openapi 是一个 npm 包，它能够帮助我们使用 OpenAPI 规范来生成 RESTful API 的客户端库。
使用 @microsoft.azure/openapi
在使用 @microsoft.azure/openapi 之前，我们需要先安装它：
npm install @microsoft.azure/openapi
安装之后，我们就可以使用它来生成客户端库了。我们需要一个 OpenAPI 规范的 JSON 或 YAML 文件，然后使用下面的命令来生成客户端库：
autorest --input-file=openapi.json --nodejs --output-folder=src/generated
在这个命令中，我们指定输入文件为 openapi.json，输出 Node.js 客户端库到 src/generated 目录下。
在生成的客户端库中，我们可以看到请求和响应模型、API 调用方法和错误模型等。
示例代码
下面是一个使用 @microsoft.azure/openapi 生成客户端库的示例代码。假设我们要调用一个名为 "hello" 的 API，它的 OpenAPI 规范如下：
-- -------------------- ---- -------
-------- -----
-----
------ ----- ---
-------- -----
--------- ----
------
-------
-----
------------ --------
------------ --- ----- -- --------
---------
- ----------------
-----------
- ----- ----
--- -----
----- ------
- ----- -------
--- ----
-------
----- ------
-----------
--------
----- ------
---
----- ------
----------
------
------------ --
-------
----- ------
-----------
--------
----- ------
-----
----- ------我们可以使用以下命令来生成 Node.js 客户端库：
autorest --input-file=hello_api.yaml --nodejs --output-folder=src/generated
生成的客户端库会包含一个名为 HelloAPIClient 的类，我们可以使用它来调用 API：
-- -------------------- ---- -------
----- - -------------- - - ---------------------------
----- ------ - --- ----------------------------------------
----- -------- ------ -
----- -------- - ----- -----------------
---------------- -
----- --------
--
------------ -
-------- --------
--- --------
--
---
---------------------------
-
-------------------- -- -
---------------------
---在上面的示例代码中，我们首先导入 HelloAPIClient 类，然后创建一个客户端对象并指定 API 的基本 URL。接下来，我们调用 sayHello 方法并传入参数。最后，我们输出 API 的响应结果。
结论
使用 @microsoft.azure/openapi 可以帮助我们快速生成 RESTful API 的客户端库。我们只需要提供一个 OpenAPI 规范的 JSON 或 YAML 文件，然后使用 autorest 命令来生成客户端库。在生成的客户端库中，我们可以看到请求和响应模型、API 调用方法和错误模型等信息。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600673e0fb81d47349e53cd9