Swagger annotations和Swagger spec 2.0

时间:2015-06-16 13:48:19

标签: swagger swagger-2.0 swagger-editor

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

问题:   我正在尝试使用swagger提供的url根据我的anotations生成符合此规范的客户端。   问题似乎是不相容的,或者至少,我不知道如何做swagger editor读取我的网址,从那时起生成客户端。但昂首阔步的编辑向我报告了一些错误......

可以将我的anotated swagger api与一个招摇的编辑器集成在一起吗?

感谢。

3 个答案:

答案 0 :(得分:3)

这个问题似乎有点令人困惑。

如果您尝试从REST API Swagger规范生成客户端,那么您应该查看Swagger-Codegen项目。

项目描述:

  

swagger-codegen包含一个模板驱动的引擎,通过解析您的Swagger资源声明来生成不同语言的客户端代码。

答案 1 :(得分:0)

不确定我是否正确理解了这个问题。如果您想在线生成API客户端,请使用http://generator.swagger.iohttp://editor.swagger.io除外)。以下是为Java生成API客户端的示例:

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

答案 2 :(得分:0)

Swagger编辑器仅用于编辑json或yml格式的swagger规范。它不以任何方式处理招摇注释。但是,在swagger编辑器网站上生成的某些服务器框架包含注释。注释是一种反向工程API以生成json文件的方式,以便swagger UI可以基于swagger.json文件的公共URL路径呈现网页。 如果你正在维护一个swagger spec json文件,那么注释并不是真的需要,你也可以只提供原始的swagger.json本身,而不是注释生成的json。

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