问题标签 [swagger-3.0]

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 投票
0 回答
785 浏览

swagger - 如何在 Swagger 中添加文件上传字段

我正在尝试以大摇大摆的方式指定文件输入。

导入用户:

文件上传按钮显示在编辑器中,但出现以下错误:

components.schemas.ImportOperatorDevice.properties.csv_file.type 的结构错误应等于允许的值之一 allowedValues:数组、布尔值、整数、数字、对象、字符串

0 投票
0 回答
302 浏览

node.js - 在大摇大摆中生成NodeJs服务器代码时出错

在尝试生成nodejs服务器时,我收到以下错误。

有什么办法可以解决这个错误吗?

提前致谢

0 投票
1 回答
3589 浏览

spring-boot - springfox 实现可用于 swagger3 或 openapi 3?

除了 JAX-RS 之外,是否有任何springfox可用于支持端点媒体类型版本控制的 OpenAPI 3 实现?swagger3

0 投票
2 回答
3181 浏览

java - Swagger core v3在java中的实现

我正在编写一些 API,并且我想在编写代码时集成文档,所以我发现 Swagger 是实现此目的的好方法。

我使用了 Swagger 核心 v3 表示法,所以我的类类似于:

我创建了一个配置类:

并且我想启用 Swagger 的 UI 来获取文档,但是当我进入: .../swagger-ui.html

我得到:

无法呈现此定义 提供的定义未指定有效的版本字段。

请指明有效的 Swagger 或 OpenAPI 版本字段。支持的版本字段是 swagger:"2.0" 和那些匹配 openapi:3.0.n(例如,openapi:3.0.0)。

0 投票
0 回答
2739 浏览

swagger-ui - 混合内容错误 - 通过 HTTPS 提供服务时,swagger-ui 应该更喜欢 HTTPS API 协议

当要招摇 ui 链接时,我在控制台中看到错误>

等等所有资产

我已经修改了我们正在生成文档的女巫的 API 文档 json 文件。这部分并将http更改为https

我希望在看到 swagger UI 时不会收到此错误

0 投票
1 回答
6152 浏览

swagger - 无法引用在 Swagger 的单独文件中定义的组件架构

我有以下 api 文档:

其中 AuthError 架构在名为 components.yaml 的单独 yaml 文件中定义:

和 Swagger 配置:

但是当我尝试访问 Swagger UI 时,出现以下错误:

路径解析器错误。/users.get.responses.403.schema.$ref 无法解析引用:尝试解析相对 URL,但没有 basePath。路径:'components.yaml' 基本路径:'未定义'

我在这里想念什么?

0 投票
0 回答
417 浏览

swagger - 如何为 requestBody of content "text / csv (UTF-8)" 定义 Open Api 3.0 文档

我是新来的。我有一个端点,它接受'text / csv(UTF-8)格式的输入。我想为端点添加开放的 api 文档。但是我没有从官方网站 请求正文描述大摇大摆中找到任何示例

我必须指定

任何建议都会对我有所帮助。

提前致谢

0 投票
2 回答
1034 浏览

java - 使用 springfox-swagger2 版本 3.0.0-SNAPSHOT 观察错误“无法推断基本 url”

spring-boot 2.1.6.RELEASEspringfox-swagger2版本一起使用3.0.0-SNAPSHOT。但无法启动 swagger-ui(即http://localhost:808/swagger-ui.html)或 api-docs (即http://localhost:8080/v2/api-docs)网址。

相同的配置适用于springfox-swagger2 version 2.9.2. 唯一的区别是加上@EnableSwagger2WebMvcwith 3.0.0-SNAPSHOT

错误详情

在此处输入图像描述

这是我的pom.xml

这是Swagger 配置

控制器接口

控制器实现

春季启动应用程序

springwebframework 日志TRACE

我不确定将 springfox-swagger2 与 3.0.0-SNAPSHOT 版本一起使用时缺少什么。我根本没有启用任何安全性。我想使用普通的香草弹簧网和招摇。非常感谢解决此问题的任何指示。

0 投票
0 回答
28 浏览

swagger - 如何在 swagger-php 中删除请求正文示例下拉列表

我正在使用Swagger 3.0swagger-php获得

请求正文标记的奇怪行为

.

在图像中,“示例:”下拉菜单出现,“示例值 | 架构”显示在该下拉列表下方,而不是“示例值 | 模型”。

我的问题是:

  1. 如何删除示例下拉列表?

  2. 如何为下拉列表添加多个示例?

  3. 为什么我的sagger-ui show“示例值 | 架构”而不是“示例值 | 模型”?

  4. 是否有未列出的有关请求正文示例的更新文档?

我正在关注第 40 行的帖子示例

https://github.com/zircote/swagger-php/blob/master/Examples/petstore-3.0/controllers/User.php

https://github.com/zircote/swagger-php/blob/master/Examples/petstore-3.0/models/RequestBody.php

https://github.com/zircote/swagger-php/blob/master/Examples/petstore-3.0/models/User.php

这是我的标记:

示例下拉图片

0 投票
1 回答
559 浏览

swagger - 在 OpenAPI 3 中将参数传递给“$ref”

假设我有以下模式可以在以后使用$ref

但我有另一个类似的模式:

它们之间的唯一区别是itemIdand petId,我只想创建一个模式并在引用时通过itemIdor 。petId如何做到这一点?有没有替代解决方案?