什么是 egg-swagger-ui?
egg-swagger-ui 是一个基于 egg.js 框架的插入式用户界面，它允许你快速和轻松地构建，文档化和测试 RESTful APIs。swagger-ui 可以在 web 上对 RESTful APIs 进行可视化，并提供了 API 调试等功能。
安装 egg-swagger-ui
你可以使用 npm 直接安装 egg-swagger-ui:
npm i egg-swagger-ui --save
配置 egg-swagger-ui
在 egg.js 的配置文件 config/plugin.js 中添加 egg-swagger-ui 插件:
exports.swaggerui = {
enable: true,
package: 'egg-swagger-ui',
};在 egg.js 的配置文件 config/config.default.js 中添加 egg-swagger-ui 插件的配置:
exports.swaggerui = {
enable: true,
package: 'egg-swagger-ui',
router: '/api-docs' // 如果需要指定 swagger-ui 的路由路径，则在这里进行配置
};使用 egg-swagger-ui
在你的 egg.js 的路由定义文件中，你可以添加以下代码:
-- -------------------- ---- ------- -------------- - --- -- - ----- - ------- ---------- - - ---- -- --- ---- ---------- ----- ---- --------------- ----------------------- -- --- ---------- ----- ---- ------------------------------- --
接下来，你可以访问 http://localhost:7001/api-docs 来查看你的 API 文档。如果你在配置中指定了不同的路径，则应该访问你指定的 url 路径。
接下来，你可以通过以下方式来定义路由数据:
-- -------------------- ---- ------- --- - -------- - ----------------- - ---- - ----- - - ----- - -------- ------ - ------------ ------ - --------- - - ---------------- - ---------- - ---- - ------------ ----- - ------- - ----- ------------------------ -- ------------------------------ --------------------------------
这里是一个示例代码，在响应结果中返回的是用户列表数据。
检查 API 文档
你可以使用 Swagger-Editor 检查你的 API 文档，它可以帮助你检查格式是否正确。Swagger-Editor 提供了一个可视化的编辑器来检查 Swagger API JSON 文件。
总结
在本文中，我们介绍了 egg-swagger-ui 是什么以及如何安装，配置和使用。同时，我们也向您展示了如何通过以下方式定义路由数据，以便您可以创建一个 API 文档。
-- -------------------- ---- ------- --- - -------- - ----------------- - ---- - ----- - - ----- - -------- ------ - ------------ ------ - --------- - - ---------------- - ---------- - ---- - ------------ ----- - ------- - ----- ------------------------ -- ------------------------------ --------------------------------
在创建和发布 RESTful API 时使用 Swagger 是一种最佳实践。我们希望这篇文章对你有所帮助，可以让你更快地了解这个工具，以便更好地创建和管理你的 API。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60057c4781e8991b448ebcbd