2015-06-16 137 views
0

我开发了一个使用Swagger注释的REST API。 我已经能够在swagger-ui应用程序上显示api文档,非常好。Swagger注释和Swagger规范2.0

问题: 我想根据这个规范生成客户端使用由swagger提供的URL根据我的偏移量。 该porblem似乎是不兼容的,或者至少,我看不到如何做swagger editor读取我的网址,并从此,生成客户端。但招摇吧编辑向我报告了一些错误...

可以将我的anotated swagger api与swagger编辑器集成吗?

谢谢。

回答

0

不知道如果我理解正确的问题。如果您想在线生成API客户端,您可以使用http://generator.swagger.io(除http://editor.swagger.io之外)。这里是生成API客户端的Java的例子:

curl -X POST -H "content-type:application/json" -d '{"swaggerUrl":"http://petstore.swagger.io/v2/swagger.json"}' http://generator.swagger.io/api/gen/clients/java 
0

扬鞭编辑器仅用于JSON或YML格式编辑招摇规范。它不会以任何方式处理swagger注释。但是,在swagger-editor网站上生成的一些服务器框架包含注释。这些注释是一种反向工程的方式来生成一个json文件,这样,可以让swagger UI根据swagger.json文件的public url路径来呈现一个网页。 如果你正在维护一个swagger spec json文件,那么注释并不是真的需要,你可能只需要提供原始的swagger.json本身,而不是由注释生成的json。

至于你的问题,“是否有可能将你的API与swagger编辑器集成?”......任何事情都是可能的,但我不确定你想如何或为什么要整合它们。

+0

你会用什么工具对API进行逆向工程,并根据注释生成swagger.json? – wimnat