简介
express-route-discovery 是一个 Node.js 模块，适用于 Express 框架，可以自动为你的 express 应用程序生成 API 文档，供开发人员和用户查看。
这个模块使用了 express 框架提供的路由信息，并且可以自定义文档的显示样式。如果你的应用程序使用了这个模块提供的 API 文档，那么你的团队成员就可以立即获得更好的应用程序和更高的生产力。
安装和配置
安装 express-route-discovery 可以使用 npm，执行以下命令即可:
npm install express-route-discovery --save
你需要做以下一些配置：
-- -------------------- ---- -------
----- ------- - -------------------
----- --- - ----------
----- --------------------- - -----------------------------------
-------------------------------
--------- -
----- ----- ----------- ------
------------ ----- ----------- -------------
-------- ----- ----------- ---------
--------- ------
--
-------------- ------------
----
---------------- -- -- -------------------- --- --------- -- ---- ---------配置的详细信息如下：
settings中包含应用程序的基本信息。需要提供以下信息：name(string) - 应用程序名称description(string) - 应用程序描述version(string) - 应用程序版本号basePath(string) - API 的基本路径
customCssPath(string) - 在文档页面中使用自定义样式表文件。该文件应该存在于公共路径下。
使用方法
通过设置 expressRouteDiscovery，你可以使用以下路由：
http://localhost:3000/api/documentation- 生成 API 文档的主页；http://localhost:3000/api/json- 在 JSON 格式中获取 API 结构。
自定义样式表文件
您可以使用自定义样式表文件来使您的 API 文档更好看。 您可以在文档页面中使用自定义样式表文件。请确保样式表文件可用于公共路径，否则样式文件无法加载。
以下是样式表文件的示例所需格式:
-- -------------------- ---- ------- ----- - ------- - ----- - ------- - ----------------- -------- ------ ------ ---------- ------ ------------ ------- -------- ----- -
现在已经有了 custom.css 文件，你只需要在启动应用程序时增加如下代码：
-- -------------------- ---- -------
-------------------------------
--------- -
----- ----- ----------- ------
------------ ----- ----------- -------------
-------- ----- ----------- ---------
--------- ------
--
-------------- ------------
----接下来，在主页的标签使用 link 标签引入样式表即可：
-- -------------------- ---- -------
--------- -----
------
------
----- ----------------
----- --------------- ---------------------------- -----------------
---------- ---------------------
----- ---------------- --------------- -------------------
-------
------
---- ---- ------ ---- ------- ---- ---
-------
-------示例代码
以下是使用 express-route-discovery 的最基本的示例代码：
-- -------------------- ---- -------
----- ------- - -------------------
----- --- - ----------
----- --------------------- - -----------------------------------
-- --- --- ----------
-------------------------------
--------- -
----- -------- -----
------------ -- ------ --- --- ----------
-------- ------
--------- ------
-
----
-- ------ --- ------
----------------------- ----- ---- -- -
-------------- -- --- ------- ------
---
-- ----- --- ------
---------------- -- -- -
------------------- -- ------- -- ------------------------
---总结
通过本文，我们了解了 express-route-discovery 的用法和配置，以及如何自定义样式表文件来使您的 API 文档更好看。
通过使用 express-route-discovery，我们可以将生成 API 文档的过程简化，方便开发人员和用户访问和查看。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600572cb81e8991b448e8fa4