0

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

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

可以将我的带注释的 swagger api 与 swagger 编辑器集成吗？

谢谢。

4

3 回答 3

3

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

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

项目描述：

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

于 2015-07-02T03:24:44.860 回答
0

不确定我是否正确理解了这个问题。如果你想在线生成 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
于 2015-07-12T05:53:47.700 回答
0

Swagger 编辑器仅用于编辑 json 或 yml 格式的 swagger 规范。它不以任何方式处理招摇的注释。但是，swagger-editor 网站上生成的一些服务器骨架包含注释。注释是一种对 API 进行逆向工程以生成 json 文件的方法，以便 swagger UI 可以根据 swagger.json 文件的公共 url 路径呈现网页。如果您仍然在维护一个 swagger 规范 json 文件，那么实际上并不需要注释，您不妨只提供原始 swagger.json 本身，而不是由注释生成的 json。

至于您的问题，“是否可以将您的 API 与 swagger 编辑器集成？”...一切皆有可能，但我不确定您要如何或为什么要集成它们。

于 2015-10-23T16:36:49.563 回答