Swagger注解和Swagger spec 2.0

Question

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

问题:我正在尝试使用swagger提供的url根据我的模拟生成符合此规范的客户端。问题是它似乎是不兼容的，或者至少，我不知道如何做swagger editor读取我的url，并从那时起，生成客户端。但是swagger编辑器向我报告了一些错误...

可以将我的anotated swagger api与swagger编辑器集成在一起吗？

谢谢。

Answer 1

这个问题看起来有点令人困惑。

如果您正在尝试从REST API Swagger规范生成客户端，那么您应该考虑Swagger-Codegen项目。

项目描述：

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

到存储库的

• 链接:官方页面：http://swagger.io/swagger-codegen/

的

Answer 2

不确定我是否正确理解了这个问题。如果你想在线生成API客户端，你可以使用http://generator.swagger.io (除了http://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

Answer 3

Swagger编辑器仅用于编辑json或yml格式的swagger等级库。它不以任何方式处理swagger注解。但是，在swagger编辑器网站上生成的一些服务器框架包含注释。注释是一种逆向工程的方式，你的API生成一个json文件，这样swagger UI就可以根据你的swagger.json文件的公共url路径来呈现一个网页。如果您无论如何都要维护一个swagger spec json文件，那么实际上并不需要注释，您不妨只提供原始的swagger.json本身，而不是由注释生成的json。

至于你的问题，“有没有可能把你的API和swagger编辑器集成起来？”……一切皆有可能，但我不确定您想要如何或为什么要集成它们。