前言
在前端开发中，我们难免要与后端 API 打交道。通过手动编写 API 调用代码可能是一项费时费力的工作。为了提高效率，Autorest 库应运而生。本篇文章将介绍如何使用 Autorest 创建可用的 API 调用。
什么是 Autorest？
Autorest 是一个可以从 OpenAPI 规范（旧新增的 Swagger）中生成客户端调用库和服务器存根，尤其适用于 RESTful API 的 Microsoft 开源工具。Autorest 可以根据 API 引导文件自动生成客户端代码，这些引导文件包含 OAS（OpenAPI 规范）、Swagger 和 RAML 等。为了安装 Autorest，我们需要先安装 npm。使用以下命令安装 Autorest：
npm install -g autorest
如何生成 Autorest API 调用
假设我们已经有了一份前端样例代码，它在浏览器中请求数据并传输到后端 API。下面是针对该示例 API 的 Autorest 实现。首先需要创建一个名为 openapi.json 的新文件，以此为基础：
{
"openapi": "3.0.0",
"info": {
"description": "Web API Sample Management System Online Guide",
"version": "1.0.0",
"title": "Web API Sample Management System"
},
}在文件中添加 API 信息：
-- -------------------- ---- -------
-
---------- --------
------- -
-------------- ---- --- ------ ---------- ------ ------ -------
---------- --------
-------- ---- --- ------ ---------- -------
--
---------- -
-
------ -----------------------
-
--
-------- -
------------------- -
------ -
------- -
--------
--
-------------- -------------
----------- ---
----------- -
-------------
-------------------
------------
------------------
----------
--
------------- -
-
------- -----
----- -------
----------- -----
------- ----------
--------- -------
-
--
------------ -
------ -
-------------- ----------
--------- -
------- ----------------------
-
--
------ -
-------------- ---- ------
-
--
------------- -----
-
-
-
-然后运行以下命令：
autorest --input-file=openapi.json --typescript && npm install
事实上 --typescript 参数指定 Autorest 应该使用 TypeScript 而不是 JavaScript 生成代码。生成文件后，我们就可以开始调用 API 了：
-- -------------------- ---- -------
------ - ---------- - ---- -----------------------
------ - ---------- ------ - ---- ----------------
------------
--------- -----------
------------ -----------------------
--
------ ----- ------------ ---------- ------ -
---- ----
------------------- ----- ----------- --
----------- ---- -
--------------------------------------------------------------
----- -- -
-------- - ----
--
----- -- -
-------------------
-
--
-
-总结
Autorest 是一种非常有用的用于生成 API 调用的工具。通过简单的配置和几个简单的命令，你可以在几分钟内开始工作，以便于 API 的编写和执行调用。希望这篇文章能够帮助你了解 Autorest 的使用，提高你的开发效率，在你的项目中带来极大的价值。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5f6c3263a9b7065299ccb927