swagger-2.0相关内容

如何包装 JSON 对象?

我目前正在寻找一种将 JSON 包装到 Swagger UI 组件中的方法. 在 YAML 中，我的对象声明是: 休息异常:特性:信息:类型:字符串 Swagger UI 生成的输出是(我同意，是正确的):{“消息":“字符串"} 而我想要的是: "restException": {“消息":“字符串"} 我只是通过在 YAML 文件中明确声明包装器找到了一种丑陋的方法.但这 ..
发布时间：2022-01-22 17:36:13 其他开发

如何从 OpenAPI/Swagger 模型定义生成 JSON 示例?

我正在为具有 OpenAPI (Swagger) 定义的 REST API 构建一个模糊器. 我想测试 OpenAPI 定义中的所有可用路径，生成数据以测试服务器，分析响应代码和内容，并验证响应是否符合 API 定义. 我正在寻找一种从模型定义中生成数据(JSON 对象)的方法. 例如，给定这个模型: ...“宠物": {“类型":“对象"，“必需的": [“名称"，“照片网址 ..
发布时间：2022-01-22 17:35:47 其他开发

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

假设我有一个像 limit 这样的参数.这个到处都在使用，如果我需要更新它，就不得不到处更改它是一件痛苦的事: 参数:- 名称:限制在:查询描述:限制返回结果的数量必需:假类型:数字格式:int32 我可以使用 $ref 在别处定义它并使其可重用吗?我遇到 这张票 这表明有人想要更改或改进功能，但我不知道它今天是否已经存在? 解决方案 这个功能在 Swagger 2.0 中已经存在.链 ..
发布时间：2022-01-22 17:35:15 其他开发

Swagger:从枚举中取一个或多个值

我正在编写一个 OpenAPI (Swagger) 定义，其中查询参数可以不带任何值或 N 个值，如下所示: /path?sort=field1,field2 如何在 OpenAPI YAML 中编写这个? 我尝试了以下方法，但没有产生预期的结果: - 名称:排序在:查询架构:类型:字符串枚举:[field1,field2,field3]允许空值:真必需:假描述:按属性对结果进行排序. ..
发布时间：2022-01-22 17:34:45 其他开发

Swagger 2.0:具有不同路径但请求和响应相同的多个 Path 对象

由于某些向后兼容的原因，我需要同时支持路径 /ab 和 /a-b. 两个路径的请求和响应对象将是相同的. 我能否在我的 Swagger 规范中包含类似以下内容，这样我就不必为两个路径重复请求和响应对象定义. 路径:/ab:/a-b:邮政:... 解决方案 是的，你可以有一个引用另一个路径项的路径项: 路径:/ab:邮政:概括: ......回复:.../a-b:$ref: '# ..
发布时间：2022-01-22 17:34:30 其他开发

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

有谁知道如何在 OpenAPI 2.0 定义中定义可能的“枚举"值，以便它们显示在 Swagger UI 的“模型"选项卡中?此处示例:https://petstore.swagger.io/#!/pet/addPet 具有 status 属性的枚举选项.如何在 OpenAPI 2.0 中定义这样的枚举? 解决方案 “枚举"在 OpenAPI 2.0 中像这样工作: {“在":“查询" ..
发布时间：2022-01-22 17:34:24 其他开发

使用 $ref 时忽略 Swagger 模式属性 - 为什么?

我正在尝试建立一个时间间隔的Swagger模型，使用一个简单的字符串来存储时间(我知道还有datetime): 定义:时间:类型:字符串描述:时间以 24 小时格式“hh:mm".时间间隔:类型:对象特性:下限:$ref:“#/定义/时间"描述:时间间隔的下限.默认值:“00:00"上界:$ref:“#/定义/时间"描述:时间间隔的上限.默认值:“24:00" 由于某种原因，生成的 HTML ..
发布时间：2022-01-22 17:33:33 其他开发

如何在 OpenAPI 2.0 中定义混合类型数组(具有不同元素类型)?

我试图将以下 JSON 映射到 OpenAPI 2.0 (Swagger 2.0) YAML 定义，但我不确定如何将混合数组类型设置到我的架构中: {“obj1":[“字符串数据"，1]} 现在，我的 OpenAPI 定义有: 模式:对象1:类型:数组项目:类型:字符串 但这不允许在数组中使用整数. 有没有办法定义混合类型数组? 解决方案 答案取决于您使用的 OpenAPI ..
发布时间：2022-01-22 17:32:17 其他开发

我如何表示“授权:承载 <token>"在 Swagger 规范中 (swagger.json)

我试图传达身份验证/安全方案需要设置如下标头: 授权:Bearer 这是我基于 大摇大摆的文档: securityDefinitions:API密钥:类型:apiKey名称:授权在:标题安全:- API密钥:[] 解决方案 也许这会有所帮助: 招摇:'2.0'信息:版本:1.0.0标题:基于“基本身份验证示例"描述:>如何将 Auth 与 Swagger 一起使用的示例.主机:bas ..
发布时间：2022-01-22 17:31:29 其他开发

如何在 SwaggerHub 中返回对象数组?

我正在使用 OpenAPI 2.0 在 SwaggerHub 中定义 API 规范./contacts 请求返回一个联系人数组.定义如下: /contacts:得到:标签:- 联系人摘要:获取所有联系人描述:这会显示用户的所有联系人.operationId:获取联系人产生:- 应用程序/json- 应用程序/xml回复:200:描述:操作成功架构:$ref: '#/definitions/All ..
发布时间：2022-01-22 17:30:43 其他开发

将 postman api 调用转换为 Node.js 调用

我在尝试向使用 swagger 2.0(不是我)创建的 API 发出发布请求时遇到了一些麻烦. 我已经向邮递员导入了一个集合，当我执行一个发布请求时，它工作得很好.但是在 Node.js 中，它使用 swagger 库输出 400 错误，使用 axios 输出 500. 这是该集合在邮递员中提供的架构: {“工作流功能ID":1，“工作流操作参数":[{“名称":“描述"，"valu ..
发布时间：2022-01-22 14:33:33 其他开发

如何重用 swagger 定义并删除其中的一些参数?

这是我的代码: 定义:用户:类型:对象特性:ID:类型:整数用户名:类型:字符串名:类型:字符串姓:类型:字符串密码:类型:字符串created_at:类型:字符串格式:日期时间更新地址:类型:字符串格式:日期时间必需的:- 用户名- 名- 姓- 密码/api/用户:邮政:描述:添加新用户operationId:商店参数:- 名称:用户描述:用户对象在:身体要求:真类型:字符串架构:$ref: ..
发布时间：2022-01-14 11:12:04 其他开发

Swagger/OpenAPI 模拟服务器

我在 Swagger 文件中有一个 API 参考.我想创建一个非常简单的模拟服务器，这样当我调用例如: mymockurl.com/users 它将返回一个预定义的 JSON(无需连接到数据库). 最简单的方法是什么?我不是后端人员. 解决方案 SwaggerHub 为 OpenAPI 2.0 和3.0 规格.免费和付费计划均支持模拟. 要使用模拟服务器，请将您的规范导入 ..
发布时间：2022-01-08 21:27:13 其他开发

具有动态键值哈希映射的 Swagger 复杂响应模型

我正在努力使用 swagger 的语法来描述响应类型.我要建模的是具有动态键和值的哈希映射.这是允许本地化所必需的.语言可能会有所不同，但应始终提供英语. 响应在 JSON 中如下所示: {编号:“1234"，名称: {en: "英文文本",de:“德国文本"}} 我的第一次尝试是这样的，但我不知道如何写名字的部分.AdditionalProperties 似乎是一个关键，但我无法理解它 ..
发布时间：2022-01-08 14:05:20 其他开发

如何格式化 Swagger 2.0 文本描述?

我想格式化我的 Swagger API 描述，以便它们不是简单的文本段落.最好，我想给它添加一个小桌子. 我没有在 Swagger 描述中找到有关文本格式的在线参考.如果我启动 Swagger Editor，然后打开 Instagram 示例(文件 \ 打开示例 \ Instagram.yaml), 我看到 yaml 文件中的第一个描述显示了一些格式，包括超链接和边界框: [注册你的客户 ..
发布时间：2021-12-08 23:13:37 其他开发