问题标签 [swagger-2.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 投票
8 回答
34075 浏览

swagger - 如何将 swagger 2.0 JSON 文件分解为多个模块

我正在尝试将我的 API 文档分解为多个可以独立编辑的 JSON 文件。我能找到的所有示例都使用 Swagger 1.2 模式,它有一个“api”:{} 对象来分解它。2.0 模式 ( http://json.schemastore.org/swagger-2.0 )似乎缺少这点。所定义的只是一个单一的“路径”数组,它将所有 API 端点捆绑到该单一数组中。这在 swagger-ui 中的效果是有一个单一的“默认”类别,所有东西都被捆绑到其中,我无法告诉将其拆分。

TLDR:如何从 swagger 2.0 模式中的路径拆分操作

0 投票
3 回答
670 浏览

swagger - 为定义的 Swagger 路线提供替代(国际)拼写

我正在使用具有端点的 swagger 中的 API 规范:

我也想为此端点定义一个替代拼写(授权)。这可能吗?还是我需要为每个拼写定义单独的路线?

0 投票
2 回答
50318 浏览

swagger - Swagger/OpenAPI - 使用 $ref 传递可重用的定义参数

假设我有一个像limit. 这个在所有地方都被使用,如果我需要更新它,必须到处更改它是一件痛苦的事情:

我可以使用 $ref 在其他地方定义它并使其可重用吗?我看到这张票表明有人想要更改或改进功能,但我不知道它今天是否已经存在?

0 投票
4 回答
108913 浏览

swagger - 如何在 OpenAPI (Swagger) 中定义枚举?

有谁知道如何在 OpenAPI 2.0 定义中定义可能的“枚举”值,以便它们显示在 Swagger UI 的“模型”选项卡中?此处的示例:httpsstatus ://petstore.swagger.io/#!/pet/addPet 具有该属性的枚举选项。如何在 OpenAPI 2.0 中定义这样的枚举?

0 投票
1 回答
908 浏览

swagger - 引用多个预定义的 swagger 2.0 参数定义抛出错误

我在我的 swagger 2.0 文件中定义了两个可重用的参数:

然后在我的路由定义中(在这种情况下为 GET)我试图像这样引用两者:

如果我使用一个 $ref,它似乎可以正常工作(没有编译错误),但如果我尝试同时使用这两个,它会盯着我看:

此外,如果我在查询字符串中传递这些参数并输出req.swagger.params,我会得到一个空对象。我究竟做错了什么?

这是规范的完整 SSCCE,产生相同的错误:

0 投票
1 回答
630 浏览

swagger - Swagger ... 从 Mustache 访问查询参数属性

我使用 Mustache 和 swagger-codegen 从定义生成模型实体,并从操作(路径部分)生成代码。每个操作指定一个参数列表和其他参数属性 - 数据类型、描述、默认值、必需、最大值、示例等。

除了“必需”属性之外,我无法弄清楚如何访问任何参数属性......除了在“模型”阶段......我如何在“api”阶段做到这一点?...我希望能够删除验证参数是否满足“必需”之外的条件的代码,例如最小/最大等。

0 投票
1 回答
1889 浏览

reference - 是否可以定义参数集并引用它?

我有多个要引用的参数,但我不想一一指定。

此代码段不会显示参数:

这是可能的还是我必须set1为每个请求指定每个参数,例如 , ?

0 投票
1 回答
137 浏览

import - Bluemix API Manager Swagger 2.0 导入忽略“formData”变量

在此代码中,导入了路径和查询变量,但没有导入表单数据变量。但是,(非 IBM)Swagger UI 可以正确显示它。

为什么?

0 投票
1 回答
184 浏览

import - 无法使用参数参考将 Swagger 2.0 导入 API Manager

当我尝试使用参数引用将 Swagger 2.0 文件导入API 管理器时,我收到以下错误:

无法处理 API 请求。有关详细信息,请参阅服务器日志,或联系您的管理员。

Swagger 定义如下所示:

但是,当我直接指定参数时,导入成功:

为什么会失败?这是不受支持还是错误,或者我错过了什么?

有没有办法让我查看服务器日志以获取有关失败的更多详细信息,如错误消息中所述?

0 投票
1 回答
2127 浏览

swagger - Swagger:支持可选路线

我有一条带有可选参数的路线:

但是,当我没有为请求本身提供categoryId调用的值时......{categoryId?}