问题标签 [swagger-codegen]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
1 回答
9059 浏览

json - 为同一个项目中的多个 swaggers 生成代码

如何从一个 pom.xml 中的同一模块/项目中为多个 swagger 文件生成代码。

在我的应用程序中,客户端提供了一个招摇,我们有一个要调用的后端 API,他们提供招摇。我想在同一个项目中为这两个生成代码。我想的一种方法是创建单独的模块并单独执行插件,并在主模块中调用这些依赖项。

如何从一个构建插件生成代码?如果是转发,请指出我现有的。我找不到任何东西。

这是我在 pom.xml 中配置的插件

还尝试了 *.json。在任何时候,它只需要一个 json 文件并生成代码。

0 投票
1 回答
1467 浏览

java - Spring Swagger Codegen Maven 插件 oAuth2 客户端示例

我对 Spring 和 Java 有点陌生,有人可以提供一个示例来调用一个 API,该 API 使用 ApiClient 使用 OAuth 访问令牌,它是使用 swagger 插件自动生成的?通过在下面的示例代码中提供客户端 ID、秘密和 oAuth 目标 URL。请指教。

以下是本博客中的示例代码。

https://blog.philipphauer.de/enriching-restful-services-swagger/

0 投票
1 回答
10913 浏览

rest - 如何为 REST API 生成 Swagger 文件

我的要求是为给定的 ReST API URL 生成一个 Swagger 文件。我已经使用 POSTMAN 客户端调用了下面提到的 URL,它工作正常。

但是,要在 Informatica 中使用此 URL,需要关联 Swagger 文件(json 或 yaml 格式)。

我只是 ReST API 的最终用户,并不知道它的代码。

以下是使用的 URL。

https://app.informaticaondemand.com/ma/api/v2/user/login [方法=POST]

https://app2.informaticacloud.com/saas/api/v2/activity/activityLog?rowLimit=1000 [方法=GET]

请建议任何 3rd 方实用程序来帮助创建 Swagger 文件,而不是提供这些 API。

谢谢,

汤姆乔治

0 投票
0 回答
780 浏览

swagger - Swagger-Codegen 生成多种语言的客户端

我目前正在尝试使用 Swagger-Codegen 为多种语言创建 Swagger 客户端。对于一种语言来说一切都很好,但是当为多种语言做这件事时,复杂性似乎不必要地增加了。

我的 config.json 文件中的某些选项在其他语言中不受支持/不可用,因此我必须为每种语言创建一个配置文件,这使得执行版本 bumb 变得荒谬复杂。所以我目前的方法是编写一个脚本,多次调用 Swagger-Codegen,为每种语言传递不同的配置参数。但是,这似乎更像是一种 hack 而不是解决方案,所以我想知道我是否遗漏了文档中的任何内容,或者你们中的任何人是否提出了更好的解决方案?

0 投票
0 回答
210 浏览

json - 带有 $ref 的 JSON 模式引用

我在多个文件(多个 .json 文件)中有多个架构定义,

JSON 模式是否允许在多个目录中的多个 .json 文件中定义模式?还是应该所有模式定义(所有 *.json 文件)都驻留在一个目录中?

无法从http://json-schema.org/latest/json-schema-core.html获得太多信息。

我问的原因是在Java应用程序中从.json文件生成POJO时,jsonschema2pojo插件能够处理多个目录,而swagger code-gen插件只能处理一个目录。我想知道它的 JSON-Schema 指南或插件是否存在缺陷。

0 投票
1 回答
5116 浏览

java - Swagger - 如何使用 swagger-codegen 并长期构建项目

Swagger 项目非常适合用各种语言轻松创建客户端和服务器应用程序,但我不明白如何以适当的方式维护或扩展现有项目。

我正在生成一个 Java 服务器 - 语言参数是jaxrs-spec.

我已经编写了自己的Mavenpom 并使用了swagger-codegen-maven-plugin,所以现在我可以直接使用 maven 生成模型或 api。

我看到每次我重建我的项目时,API 都会被swagger-codegen插件完全重写。

我需要实现我的应用程序逻辑,目前除了自定义生成的 API 源之外,我没有看到任何其他方法。因此,为了避免在每次构建时丢失我的工作,我可以配置.swagger-codegen-ignore(我确实做到了),但我只是推迟了这个问题。

因为第一次我必须更新swagger.json,我唯一的选择是重新生成整个 API 并覆盖我的工作。好的,我可以使用 git 并尝试恢复已删除的部分,但这确实是一个丑陋的解决方案。

所以,问题是:

使用swagger-codegen(或一般的 Swagger)是否有模式、操作方法、记录方式允许我添加行为和/或扩展生成的 API 而不会覆盖我的代码?

0 投票
1 回答
1146 浏览

python - Python Connexion - 响应修剪

我正在使用Swagger Editor生成 Python Flask 服务器,我遵循了Connexion文档,但出现了问题:

我在 swagger YAML 文件中定义了以下响应:

我期望的是返回以下响应:

但是,数据库 API 返回一个更大的数据集,例如:

为了返回我期望的响应,我有 2 个解决方案,但它们都不是完美的:

解决方案1:

手动定义一个较小的数据集,例如:

但很明显,对于每个响应,我都必须硬编码一个变量_response,这意味着我必须在 2 个位置(大张旗鼓的 YAML 和代码)维护响应属性。

解决方案2:

模型是由 swagger codegen 生成的,所以我必须访问模型并尝试获取响应属性,例如,用户模型可能定义如下:

这可能很容易,但实际上响应属性有很多 $ref 并且 $ref 中总是有 $ref。我找不到轻松获得所有属性的方法。

所以我的问题是,最好的解决方案是什么?

非常感谢!

0 投票
1 回答
438 浏览

swagger - 是否可以根据 body 参数指定 Swagger Routes

我有一个不太 RESTful 的现有 API。我试图使用 Swagger 快速组装一个 Mock Server,这样我就可以在不依赖服务器的情况下测试应用程序。当我开始编写 yaml 规则时,我意识到对于路由的子集,正在使用相同的端点并且服务器会解析 body json 以确定请求的确切内容。有没有办法使用 Swagger 对这种行为进行建模?

(请不要评论 API 架构,它已经存在并在生产中,我没有参与设计)

0 投票
1 回答
450 浏览

swagger - 如何从javascript访问swagger yaml定义的对象

我使用 Swagger Yaml 来描述端点并生成模拟服务器。现有端点(我正在模拟)没有 100% 遵循 RESTful 原则,所以我只想覆盖模拟服务器返回的响应。简单的服务器代码如下所示:

在 Yaml 定义中,定义了一个名为 MapResponseData 的对象,如何创建该对象的实例以便可以根据需要填充它并在 res.json() 中返回?类似于以下内容:

我猜这应该是可能的,因为 Swagger 解析了 YAML 文件并且知道所有指定的定义。

0 投票
3 回答
7103 浏览

django - 使用带有用户名和密码基本身份验证的 swagger-codegen

我有一个 django rest_framework API、Swagger 和一个 Swagger UI。当我没有登录时,我可以看到非常有限的“登录”和“文档”视图。当我登录时,我可以看到很多东西。

我正在尝试使用 swagger-codegen 生成客户端:

但是,它只生成一个非常有限的客户端,提供“登录”和“文档”功能。

如何让 swagger-codegen 知道如何使用 http 基本身份验证登录,以便生成更完整的客户端?

文档说我应该执行以下操作,但我不知道它期望什么: