问题标签 [swagger-node-express]

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 回答
7043 浏览

swagger - anyOf: {$ref} 在 swagger JSON 模式定义中

我尝试使用swagger来描述 JSON API。到目前为止它看起来不错,但我不知道如何使用 anyOf 结构在 JSON 答案中定义不同对象类型的数组。

以下 JSON Schema 是有效的,它应该描述一个 Article 和 Video JSOn 对象的数组:

但在 swagger 中,对象类型始终显示为未定义,而不是“文章或视频”。

是否有可能大摇大摆地完成这项工作?

0 投票
1 回答
1270 浏览

json - 在节点 js 的 swagger UI 中添加对 json 格式的验证

嗨,我正在使用 swagger UI 在我的 node.js 应用程序中记录 API。我成功配置并且工作正常。

但我现在面临一个严重的问题。

这是我的控制器中的示例招摇代码

在此,我有payload参数,其json格式为

但如果我像过去invalid json一样

然后服务器崩溃了。我必须为这个参数添加验证,所以我怎样才能在这个特定参数上添加验证。

0 投票
2 回答
29862 浏览

restful-url - 如何开始使用 swagger-ui

什么是 swagger-ui,它有什么用?

我访问过http://swagger.io/,但我需要更多信息。

请指导我。

0 投票
0 回答
262 浏览

node.js - Swagger 使用的 API 版本已过期

我正在尝试使用 Swagger 来记录我的 API。目前,我使用 node.js 拼凑了一个快速快递应用程序。我正在使用swagger-node-express并尝试按照他们关于宠物商店的示例设置基本 GET。

尝试路线时出现以下错误。但是在网络选项卡中,我可以看到正在返回的 GET。

招摇用户界面截图

是否有 swagger-node-express 可以使用的 Swagger 更新版本?

我也确实看到Swagger UI在其页面上有“构建失败”。

所以基本上我不确定问题出在 swagger-node-express 还是它使用的 swagger 版本上。

任何人有类似的问题或知道修复?

0 投票
1 回答
195 浏览

swagger-ui - 让我的 swagger API 可以通过 swagger-ui 读取(新的 swagger-node 项目)

我正在使用带有 Express 4 的 Swagger Node 项目来构建我的 api。https://github.com/swagger-api/swagger-node

我可以使我的“swagger api”工作,但是我无法将我的 api 公开为 JSON 以供 Swagger-UI 读取(https://github.com/swagger-api/swagger-ui)。

我怎样才能实现它?我知道以前的版本我需要使用下面的方法:swagger.configureSwaggerPaths("", "/api-docs", "");

但是随着项目的变化,我不知道该怎么称呼..

0 投票
3 回答
5252 浏览

swagger - 在 Swagger-Node 中返回布尔值时出错

我是 swagger-node 的新手,我正在创建一个返回布尔类型数据的 API 方法。该方法的yaml是:

此 API 方法调用的控制器中的方法是:

当我使用 PostMan 调用此方法时,某些验证失败并显示以下消息:

我不知道如何做出包含数据的响应。如果我使用字符串作为类型,或者如果我创建一个封装布尔值的新复杂类型,我可以发送它,但我认为没有很好的解决方案......

你有什么主意吗?

0 投票
2 回答
1945 浏览

javascript - 在 swagger 文档中实现 void

我不知道如何在仅返回响应代码的节点中实现 swagger(使用 swagger-node-express 项目)函数

例如对于这个招摇路径:

我想寄回。

如果我尝试

或者

甚至

我收到错误:响应验证失败:void 不允许值

如果我发送,我会在 swagger 编辑器中收到 parseerror

我得到一个 void 不允许值

我觉得我没有选择尝试,所以我真的可以使用一些输入。

0 投票
1 回答
2482 浏览

swagger - 是否可以在 Swagger ui 之前添加登录页面?

我需要在 Swagger UI 之前添加一个单独的登录页面,以便从另一台服务器进行身份验证。从这个请求中,我将获得一个密钥,我必须将它添加到来自 swagger UI 的每个请求的标题中。

我正在使用带有 swagger 2.0 的节点服务器和 swagger-tool。

0 投票
1 回答
952 浏览

node.js - node-restify 路径可以与 swagger 一起使用吗?

node-restify库允许类似/foo/:id. 大摇大摆可以处理这样的路径吗?即类似的东西?

当我在我的应用程序中尝试此操作时,http://locahost:3001/api-docs页面如下所示:

\我尝试用字符转义双冒号。但这并没有什么不同。还尝试用双引号替换单引号。还是没有区别。我正在使用swagger-node-restify库,它是swagger-node存储库的一个分支。我究竟做错了什么?

0 投票
1 回答
1158 浏览

node.js - Node.js 5.xv/s 0.10.x 或 0.12.x

Node.js 有两个版本 5.x 和 0.10.x 或 0.12.x 。从官方网站链接https://github.com/nodesource/distributions

很困惑有什么区别。我试图在 ubuntu-server 上安装 swagger-node,如果我使用 5.x,它会为 node-modules 增加巨大的集合。但是,如果我使用 0.10.x,它只使用四个节点模块。所以有区别。

我的问题是:

  1. 5.xv/s 0.10.x 和有什么区别?
  2. 如何在 Ubuntu 上从 0.10.25 升级到 0.10.40?