什么是招摇?为什么在线编辑器不运行请求?

时间:2014-09-25 15:45:29

标签: api swagger swagger-ui apiblueprint raml

我花了最近几天试图了解我是否应该使用api blueprint,RAML或swagger。

看起来swagger拥有最大的社区,但我越接近我越觉得它在文档中非常缺乏(我被迫多次查看代码以尝试将其与我当前的项目集成),许多github问题和stackoverflow问题没有答案。

我有可能在这里遗漏一些东西吗? 我想要的只是一个帮助我编写API文档和测试端点的工具。

为什么招摇必须成为服务器逻辑的一部分?如果我在the editor中创建了swagger文件,然后直接将其提供给UI,那么它就会中断..

据我所知,它甚至会使服务器稍微变慢并强制存在许多笨拙维护的集成:p我在这里缺少什么?

2 个答案:

答案 0 :(得分:4)

我们正在努力改进Swagger的文档。当许多项目由社区驱动而不是由一个组织管理时,这有点困难。

我们实际上尝试快速回复github上的问题(我们并不总是成功),并且我们有自己的google小组来解决一般性问题,所以我们更少关注stackoverflow。

你提到的编辑器是一个新工具,作为Swagger 2.0工作的一部分,它还不是最终的。因此,它仍然有一些错误和缺少功能。用户界面也正在适应Swagger 2.0,同样的限制适用于它。

您肯定不必将其与服务器集成,您可以静态公开文档。将其与服务器集成的优势在于,如果API发生变化,则更容易维护。

答案 1 :(得分:4)

您可以尝试RAML + ramlev + Abao

步骤应为

  • 使用您的fav编辑器在RAML中编写API Spec,即。 Atom,vim
  • 使用 ramlev
  • 验证您的RAML
  • 根据API Spec
  • 实现服务器逻辑
  • 使用 Abao
  • 验证服务器逻辑