在前端开发中，文档是不可或缺的一部分。然而，对于大型项目，文档的编写和维护是一项艰巨的任务。esdoc-external-webapi-plugin 是一个 NPM 包，可以帮助前端开发人员解决这个问题。它可以自动从 Web API 中提取文档并生成文档。
esdoc-external-webapi-plugin 简介
esdoc-external-webapi-plugin 是一个 ESDoc 插件，它会在生成 ESDoc 文档时，自动从指定的网址提取 Web API 文档，并将其转换为 ESDoc 格式。此插件可用于提取全局 API 和浏览器 API 中的文档，同时也可以提供自定义类型的文档。
安装 esdoc-external-webapi-plugin
使用 npm 快速安装 esdoc-external-webapi-plugin：
npm install -D esdoc-external-webapi-plugin
配置 esdoc-external-webapi-plugin
配置 esdoc-external-webapi-plugin 的方法非常简单，只需在 ESDoc 配置文件（.esdoc.json）中添加以下内容：
-- -------------------- ---- -------
-
---------- -
-
------- -------------------------------
--------- -
------------ -
-
------ ---------------------------------------------------
---------- -------
-
-
-
-
-
-在配置中，我们指定了，我们要提取的 Web API 的网址。在这里，我们使用了 Mozilla web API，将 URL 指向了其中的 "https://developer.mozilla.org/en-US/docs/Web/API"。我们通过正则表达式 "^HTML" 来限定我们需要的 API 的 列表以 HTML 开头。
使用 esdoc-external-webapi-plugin
在 esdoc-external-webapi-plugin 安装和配置完成后，上述配置中指定的所有 Web API 的文档将被提取并转换为 ESDoc 格式，并与您的代码一起生成文档。
您也可以使用自己的 Web API 来生成文档：
-- -------------------- ---- -------
-
---------- -
-
------- -------------------------------
--------- -
------------ -
-
------ -------------------------------------
---------- ------
-
-
-
-
-
-示例代码
下面是一个示例代码，在这个示例中，我们使用 esdoc-external-webapi-plugin 来从 Mozilla web API 中提取文档并自动生成 ESDoc 文档。
-- -------------------- ---- -------
---
- -------
- ------ --------- ------- - ------
- ------ -------- ------ - ----
- -------- ------ - ----
--
-------- ------------------ ------- -
-------------------------------------- ------- -- -
------------------- - ------
---
-
---
- ------- ---- --
- ------ -------- --- - -------
- -------- -------- - ------
--
-------- --------------- -
------ ---------------------- -------- --- -
------ ---------------------------- -----
---
-结论
使用 esdoc-external-webapi-plugin 可以帮助前端开发人员轻松生成 Web API 文档。在本文中，我们介绍了 esdoc-external-webapi-plugin 的基本知识，并提供了安装、配置和使用该插件的详细说明。我们还提供了示例代码，帮助您更好的了解该插件的使用。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055eae81e8991b448dc350
