@leoendless/redoc 是一个用于生成静态文档的工具，可以将 OpenAPI 规范的数据转换为带有交互式 API 文档的 HTML 静态页面。本文将会介绍如何使用该工具进行 API 文档的生成。
前置要求
使用 @leoendless/redoc，你需要安装 Node.js 和 npm 环境。如果你没有安装，可以前往 Node.js 官网 进行下载安装。安装完成后，打开终端验证：
node -v # v14.16.1
npm -v # 6.14.2
安装
安装 @leoendless/redoc，你可以使用 npm 或者 yarn 包管理器进行安装。可以使用以下命令进行安装：
npm install @leoendless/redoc # 或者 yarn add @leoendless/redoc
使用
安装完成后，你需要准备一个包含 OpenAPI 规范数据的 JSON 文件，假设文件路径为 ./api.json，可以进行如下的操作：
-- -------------------- ---- ------- ----- ----- - ----------------------------- ----- ---- - ---------------------- ----- ------- - - -- ----- ------- ------ -------- ------------------------ ----- -- ----- ----- - --- --------------- ----- ---- - ----- ------------------- ------------------
其中 options 是可选项，用于配置生成的 API 文档页的信息，比如标题等。await redoc.render(spec) 则是用于生成 API 文档的主要函数，传入参数为 OpenAPI 规范数据。
现在可以运行脚本生成文档：
node index.js > doc.html
打开 doc.html 文件，即可看到生成的 API 文档。
@leoendless/redoc 还支持配置式的 API 文档生成，你可以按需配置不同元素的样式等，详细请参考 官方文档。
示例
下面是一个示例的 OpenAPI 规范数据，用于生成一个名为 Users 的接口：
-- -------------------- ---- -------
-
---------- --------
------- -
-------- ----- -----
---------- -------
--
-------- -
--------- -
------ -
---------- ---------
------- -
-------
--
------------- -
-
------- --------
----- --------
-------------- ---------
----------- ------
--------- -
------- ----------
---------- --
---------- ---
-
-
--
------------ -
------ -
-------------- -----
---------- -
------------------- -
--------- -
------- --------
-------- -
------- ---------
------------- -
----- -
------- ---------
-------------- ----
--
------- -
------- ---------
-------------- ----
-
-
-
-
-
-
-
-
-
-
-
-运行脚本 node index.js > doc.html，即可生成如下的 API 文档：
小结
本文介绍了如何使用 @leoendless/redoc 进行 API 文档的生成，包括必要的依赖和基本操作。通过使用 @leoendless/redoc，你可以轻松地将 OpenAPI 规范数据转换为美观、易读的文档，并且可以根据自己的需要进行一定程度的定制。希望这篇文章能够为你提供帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6006735a890c4f7277583e88