问题标签 [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.

0 投票
1 回答
680 浏览

swagger - 如果我想让 swagger-editor 保存到远程服务器中,我应该编写什么代码

我已经阅读了What are the options for swagger-editor to save json or yaml into remote backend的问题,但我仍然有一个问题,在哪里可以找到通过 swagger-editor 实现后端存储的接口文档。

0 投票
1 回答
3714 浏览

swagger - Swagger:尽管参数不同,但“等效路径已经存在”

我正在尝试将 Atom 发布协议 (RFC5023) 转换为 Swagger / OpenAPI 规范来练习编写这些规范。

我遇到了以下问题:在 Atom 中有不同类型的 URI,例如 Collection 和 Member URI。我的想法是像这样记录它:

当我这样做时,swagger-editor 声称

等效路径已存在:/{MemberURI}

这些是不同类型的 URI,在查询时会返回不同的内容。我想以不同的方式称呼它们以单独记录它们。

有没有办法做到这一点?

谢谢!

编辑:规范在 Swagger-UI 中显示得很好——这是编辑器中的错误还是 UI 只是忽略了我的错误?

0 投票
1 回答
2774 浏览

node.js - Swagger 没有为 Node.js 项目生成 API 文档,为什么?

Swagger 规范文档不会从 Swagger 集成到Node.js项目中作为子项目生成。但是,SwaggerUI已启动并运行。如果我们提供说 swagger.json 或 api-docs.json 文件,那么它正在渲染指定REST API calls。我的要求是为现有项目生成API文档。我该怎么做 ?

0 投票
1 回答
1684 浏览

node.js - Swagger 中的多个项目数组

因此,我正在使用 nodejs 创建一个用户端点以将用户添加到数据库中,并且对于 api 文档,我使用的是 swagger 编辑器,我对它完全陌生。我想要做的是添加一个具有登录名、密码、头像的用户,但该用户有多个角色我想添加到数据库中我在 swagger 编辑器的 yaml 文档中所做的就是这样

它有点像在招摇编辑器中显示我想要的东西 在此处输入图像描述

但我在 UI 中得到的只是一个输入字段 在此处输入图像描述

总之,我想要得到的是一个输入数组,其中包含用户角色并将它们输入到数据库中。谢谢

0 投票
2 回答
4633 浏览

rest - 使用路径参数打开 API POST

我正在尝试使用 Swagger-ui(swagger 2.0 版)编写 Open API 规范,但我不确定如何用POST参数表示path参数

POST /ping/{text}

我的规格如下,

并且招摇 ui 显示错误如下 -

但如果我将其更改为in: query错误消失。我究竟做错了什么?或者在开放 API 规范中指定路径参数的正确方法是什么?

0 投票
1 回答
1196 浏览

jersey - 在加载到 UI 之前编辑 swagger.json

有没有办法在将 swagger.json 加载到 ui 中之前对其进行编辑。我的要求是在将 swagger.json 加载到 UI 之前对其进行操作,swagger 团队是否提供了任何钩子来完成此操作

0 投票
0 回答
506 浏览

cors - 在 Swagger-Editor 生成的服务器上启用 CORS

我正在尝试使用 Swagger 并在尝试使用 Swagger-UI 浏览服务器时收到 CORS 错误。

我刚刚发现了 Swagger,并且一直在使用 Swagger-Editor 的“生成 Node.js 服务器”功能来在本地构建和运行服务器。

有没有办法在启用 CORS 的情况下生成服务器?

0 投票
1 回答
3717 浏览

swagger-editor - Swagger:同一路径下的多个动词在编辑器中验证,但阻止它重新启动

我有下面的招摇定义。编辑器验证它,PUT 和 PATCH 都显示在预览窗口中。

但是,如果我随后停止编辑器并尝试重新启动它,我得到:
错误:
{ [YAMLException: duplicated mapping key at line 128, column 53: ... -controller: messagesPatchOrSend

第 128 行是 "patch:" 正上方的行

YAML:

0 投票
1 回答
1326 浏览

rest - 在 Maven 构建中验证 Swagger 2.0 规范?

我正在按照设计优先的方法在 Java/Spring MVC 堆栈上构建 REST API。

我有一个手写的 Swagger 架构,我想在我的 Maven 构建中验证它,如果架构不符合 Swagger 架构规范,我希望该构建失败。

我已经尝试通过使用swagger-codegen来生成一些静态文档来做到这一点;但是 1) 它没有捕获捕获的错误swagger-editor;和2)输出不是很好(但这不是重点;-))。

有没有人自己满意地解决了这个问题?

0 投票
2 回答
2112 浏览

swagger - Swagger 2.0 是否支持矩阵参数?

Swagger 2.0 是否支持 JAX-RS 规范的矩阵参数?

JAX-RS 规范支持矩阵参数

我的应用程序中有一些矩阵参数,例如/map/color;lat=50;long=20;scale=32000. 我想为矩阵参数派生 Swagger。我使用http://editor.swagger.io;但我在编辑器中得不到任何帮助。谁能帮我?

Swagger 2.0 是否支持矩阵参数?

其他链接到矩阵参数: