问题标签 [swagger-editor]
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.
swagger - 如何在 Swagger 规范中定义一系列不同的示例?
我正在尝试使用静态 swagger 文件记录一个 API,该文件可以返回一些 JSON,其中包含一个看起来像这样的数组:
我尝试了几种不同的方法来定义我的规范,使用多态性或显式定义多个示例。这些示例总是最终看起来像:
要不就:
有没有办法在我的 swagger 规范中定义一个示例,以便 swagger-ui 显示的示例有效负载将包含一个数组,其中包含一个类型 A 的示例和一个类型 B 的示例,就像我写的第一个 JSON 一样?
swagger - Swagger Editor 正文中的多个参数
所以我明白,如果我们想要身体参数,我们必须有一个模式,我就是这样做的。问题是无论我如何尝试定义我的架构,它都不允许我拥有多个正文参数。这是我尝试过的方法之一的示例。任何帮助都会很棒!
swagger - Swagger 2.0 - 来自 Swagger 源的不一致结果
下面的大摇大摆的来源。当我运行 swagger-tools 验证器时,我没有收到任何错误。当我在编辑器中加载它时,我看到输出但它不正确 - 它显示错误的类型和不完整的成员对象。当我尝试使用代码生成器 cli java 工具时,出现以下错误:
711 [main] 错误 io.swagger.models.properties.PropertyBuilder - null 没有属性,null 712 [main] 警告 io.swagger.util.PropertyDeserializer - null 没有属性,null,{ENUM=null,TITLE=null,描述=null,默认值=null,模式=null,DESCRIMINATOR=null,MIN_ITEMS=null,MAX_ITEMS=null,MIN_PROPERTIES=null,MAX_PROPERTIES=null,MIN_LENGTH=null,MAX_LENGTH=null,MINIMUM=null,MAXIMUM=null,EXCLUSIVE_MINIMUM= null,EXCLUSIVE_MAXIMUM=null,UNIQUE_ITEMS=null,EXAMPLE=null,TYPE=null,FORMAT=null} 822 [main] 错误 io.swagger.codegen.DefaultCodegen - 名称 null 822 [main] 警告 io.swagger 的属性意外丢失。 codegen.DefaultCodegen - 跳过无效属性 { "type" : "array" }
swagger - Swagger UI - 将 JSON 规范从编辑器读取到 UI 中,无需托管
我试图通过在 Swagger 编辑器中编写文档然后将其加载到 Swagger UI 中来使用 Swagger 记录我的 API。我使用编辑器下载了我的 JSON 文件,然后使用以下命令更改了 UI 中的 /dist/index.html 文件以指向我的本地文件:
我在文件中唯一更改的是使用 spec var 指向我的 JSON 文件,但是当我打开 UI 时,它会显示一个空白 UI 页面,并显示消息“已完成加载资源信息。正在渲染 Swagger UI... “我只想在 UI 的编辑器中显示我在编辑器中创建的文档,而无需托管规范,有什么我遗漏的吗?
swagger - 如何指定以大摇大摆的方式返回pdf?
我的 swagger REST API 中有一个 get 调用,需要返回一个 pdf 文件。没有明确的示例/文档说明如何在不导致语法错误的情况下执行此操作。
和
和
都失败了。这甚至可能吗?
swagger - 我可以在 swagger 2.0 中定义嵌套数组对象吗
我们使用 Swagger 2.0 作为我们的文档。我们正在以编程方式直接从我们的数据设计文档中创建 swagger 2.0 规范。
我们的模型非常复杂且嵌套。我想了解我们是否可以定义内联定义的嵌套数组对象。
例如:
我们有很多在模型中遇到这种情况的情况,此时定义#ref 不是我们想要考虑的选项。我们需要这个来内联处理。
根据以下帖子:httpsenter code here
://github.com/swagger-api/swagger-editor/issues/603#even t-391465196 看起来它不支持处理内联定义的嵌套数组对象。
由于许多大企业的数据模型非常复杂,我们希望在 swagger 2.0 规范中支持此功能。
有没有想过要添加这个功能。
yaml - 如何在 Swagger 中指定列
如何在 swagger 编辑器中指定 3 列,以便输出应如下所示:
swagger - 在 Swagger 中创建我自己的类型
我有这个 swagger 的 YAML 代码,我需要创建自己的类型(名为 MyOwnType)。
如果我使用“MyOwnType”,则会发生编译错误。
我创建了一个定义“MyOwnType”,我可以在模式中使用:“$ref: '#/definitions/MyOwnType'”。
但是如何在参数类型上使用“MyOwnType”定义?