swagger API 界面
发布于 9 年前 作者 leapon 38044 次浏览 最后一次编辑是 8 年前 来自 分享

swagger 的 API 界面做得很炫,strongloop 就整合了 swagger 的 API 界面。有这样整合过的吗? http://swagger.io/

Screen Shot 2015-05-19 at 11.34.20 AM.png

Screen Shot 2015-05-19 at 11.34.42 AM.png

5 回复

swagger思路是不错,不过尽量避免单独使用,同时维护两套Model是很耗损开发人员精力的。loopback已经帮你实现了简单的封装过程,所以自己不太需要什么整合了。 话又说回来,我个人还是认为使用Firedoc这样的工具会比较靠谱一点,因为现在我团队的swagger基本处于随便用用的状态,搜索UI再炫也没有curl灵活可用,而且还容易出现bug,又需要分散精力去fix,况且他界面真心不酷炫的说。 可能swagger更适合嵌入到你自己开放平台中去,给你的用户去当作产品去使用,而不是在开发阶段给前端人员使用。

@yorkie 同意。维护两套Model是违反DRY(不重复)原则的。swagger用的model应该是衍生出来的。

Firedoc 不错,研究一下。

@leapon :) 有问题可随时issues

@yorkie 你是Firedoc的主力啊,赞!

生成的文档是 template based 的嚒?User guide里没看到最终文档的例子。

https://github.com/fireball-x/firedoc/tree/master/themes 这里是主题的列表,至于文档最终的样子:

  1. 默认UI在这里:http://docs-zh.fireball-x.com/api/
  2. 另外还支持直接生成markdown,firedoc在github自己的文档就是自己生成的,勉强算是自举吧哈哈:https://github.com/fireball-x/firedoc/tree/master/docs
回到顶部