【问题标题】:Expressjs REST API explorerExpressjs REST API 浏览器
【发布时间】:2015-02-24 14:51:47
【问题描述】:

我一直在玩 loopback,它有非常好的 API Explorer(不知何故让我想起了 Java 的 JMX), 显然它集成在框架本身中。

是否有一种简单的方法可以使用任何 npm 包重新创建相同的体验? 如果没有,您如何以方便的方式将您的 API 公开给客户端开发人员,除了 google 文档?

【问题讨论】:

  • 你的源代码仓库中有好的文档吗?或者只是您网站上的文档。
  • 如果您只使用 express,那么自动(!)重新创建这样的界面将非常困难。框架对您的应用程序结构一无所知。 Loopback 使用模型将其自动化。你最好的选择是自己写一些东西。
  • 哇,我得说,我喜欢那种单色编码的视图。我编写并使用 booster github.com/deitch/booster 来构建我的应用程序,因为它处理了所有凌乱的控制器、模型、验证、级联等。我的 server.js 非常干净。我绝对可以看到为助推器应用构建这种视图。

标签: node.js rest express


【解决方案1】:

聚会有点晚了,但这就是Swagger 的用途。

Swagger-tools 在 Node.js 中特别受欢迎,我可以保证!

【讨论】:

  • 回复 Stack Overflow 问题永远不会迟到。这是谷歌上的热门歌曲,它真的帮助了我 - 谢谢!
  • 不仅仅是 swagger 的用途,loopback 使用 swagger:github.com/strongloop/loopback-swagger
【解决方案2】:

你可以使用here的expressjs-api-explorer

但我想你必须将所有路由注册到你的根文件(app.js 或 server.js 或类似文件)中。我已将我的路由注册到单独的模块中(例如 post.routes.js , users.routes .js) 并且在我的 app.js 中,我只有一条 'server:port/' 路由,即 app.get('/' ,handler) 和 expressjs-api-explorer 在 UI 上只返回那个路由:

您还需要安装“jade”作为依赖项。希望这有帮助。干杯!

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2017-08-07
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2014-03-14
    相关资源
    最近更新 更多