程序员经验分享-hwhale

在 Swagger Open API 3.0 中使用另一个参数时如何指示有条件地需要一个参数

2024-03-24

我已经创建了一个 RESTful API，现在正在为该 API 的使用定义 Open API 3.0 JSON 表示形式。

当存在另一个参数时，我需要有条件地使用一个参数。所以我也不能真正使用required: true or required: false因为它需要有条件。我应该将其定义为required: false，然后在summary和/或description说使用其他参数时需要它吗？或者有没有办法定义参数之间的依赖关系？我还没找到任何东西在规格中 https://swagger.io/specification/提到这样一个案例。


来自文档：

参数依赖性

OpenAPI 3.0不支持参数依赖和互斥参数。有一个开放的功能请求：github.com/OAI/OpenAPI-Specification/issues/256 https://github.com/OAI/OpenAPI-Specification/issues/256。您可以做的就是在参数描述中记录限制并在 400 Bad Request 响应中定义逻辑。

  • 欲了解更多信息 -swagger.io/docs/specification/describing-parameters https://swagger.io/docs/specification/describing-parameters
本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)

swagger

openAPI

在 Swagger Open API 3.0 中使用另一个参数时如何指示有条件地需要一个参数 的相关文章

随机推荐

  • 如何调用显式实现的接口方法的基类实现？

    我试图调用在基类上实现的显式实现的接口方法 但似乎无法让它工作 我同意这个想法很难看 但我已经尝试了我能想到的所有组合 但无济于事 在这种情况下 我可以更改基类 但我想我会问这个问题来满足我的一般好奇心 有任何想法吗 example int

  • pytz时区转换性能

    我有来自数据库的超过 100 万个日期时间对象 我想将它们中的每一个转换为时区感知的日期时间对象 这是我的辅助函数 conv tz dt is python datetime object src tz and dest tz and py

  • 两个相同查询（不同参数）的 MySQL InnoDB 死锁问题

    我有下表 CREATE TABLE IF NOT EXISTS task id int 10 unsigned NOT NULL AUTO INCREMENT job id int 10 unsigned NOT NULL COMMENT

  • JavaFX 2 ComboBox setValue() 不设置 CB 文本

    我的问题是 使用 setValue 选择后 所选的 ComboBox 项目文本在屏幕上不可见 以下是一些细节 将项目添加到我的 CB combo getItems add a combo getItems add b combo getIt

  • Android WebView 更新后卡在放大状态

    我们有一个使用 Android WebView 的应用程序 但更新到 v99 或 v100 后 它显示网页内容放大 更新后重新启动手机可以解决该问题 但只是暂时的 一段时间后 它将再次显示放大的网页 有没有人遇到过这个问题 是不是我们做错了

  • 关于查询而不是服务，最好、最全面的 SOAP 库是什么

    我的 google fu 并没有为 java 中的 SOAP 库提供非常有希望的结果 它们主要用于设置 SOAP 服务 因为我需要与这样的服务进行通信 我意识到 SOAP 只是构建和解析 XML 的问题 但理想情况下我希望对象映射和处理透明

  • 如何仅从类名获取 QMetaObject？

    我需要获取 QMetaObject 来动态创建对象实例 如果我知道该对象 那么 QObject metaObject 就是我所需要的 如果我知道该类 那么我可以使用 QObject staticMetaObject 变量 但是 如果我只知道

  • 如何使用 PHP 将 PFX 转换为 CRT 和 PEM？

    如何使用 PHP OpenSSL 函数将 pfx PKCS12 或 p12 证书转换为 crt 和 pem 这样我就可以避免使用公共服务器上不允许的命令行工具

  • 如何防止 IPAINTING 堵塞并改善着色

    我想从中删除所有使用 IPAINTING 的文本IMAGE https i stack imgur com vxOdS jpg 我一直在尝试各种方法 最终发现可以通过OCR获得结果 然后使用阈值MASK THE IMAGE processe

  • CLR 4.0 中单个对象的大小仍然限制为 2 GB？

    据我了解 NET 中的单个实例有 2 GB 的限制 由于到目前为止我主要在 32 位操作系统上工作 所以我并没有对此给予太多关注 32 但无论如何这或多或少是一个人为的限制 然而 我很惊讶地得知此限制也适用于 64 位 NET http m

  • 在 C 中分割数组

    假设我有一个数组 我想从某些索引范围中删除元素 如果我提前知道数组的大小 数组中每个元素的大小以及要删除的索引范围 是否有任何方法可以避免复制新数组 如果您不想使用新数组进行复制 您可以考虑在同一个数组本身中执行此操作 这就是我所拥有的 i

  • 我的 UIImageView 的任务

    我需要用我的UI图像视图 突出显示UI图像视图点击后 在右侧创建一个清除按钮UI图像视图 清除UI图像视图单击创建的清除按钮 将图像命名为myimage png in UI图像视图之前已清除 任何人都可以帮我做到这一点吗 有任何示例代码 应

  • 使用 Yup 验证字符串或数字长度

    是否有验证特定长度的 yup 函数 I tried min 5 and max 5 但我想要确保该数字恰好是 5 个字符 即邮政编码 此检查会带来最佳的验证体验 Yup string required matches 0 9 Must be

  • 从当前日期获取 GMT 字符串

    我能够获得我需要的输出格式 但不是正确的时间 我需要 GMT 4 小时 的时间 var dt new Date var dt2 dt toString yyyyMMddhhmmss 有任何想法吗 输出看起来像 20120403031408

  • 停止在 hashchange 上触发 popstate

    我正在使用 History API 并使用推送和弹出状态 我想阻止 popstate 事件在某些情况下触发 其中我只将哈希值附加到 URL 例如 在某些情况下 单击锚点会附加 到 URL 并立即触发 popstate 我想避免所有场景 or

  • 使用 python3 进行字符串格式打印：有时从解压数组打印

    In my 几分钟前提问 https stackoverflow com q 56092475 2327328 我问的是如何使用python的打印str format当字符串存储在数组中时进行打印 然后答案显然是解压列表 如下所示 note

  • sqlite3_prepare_v2 正在获取 SQLITE_ERROR

    我已经花了好几个小时了 必须让它工作 它阻碍了 iPhone 应用程序的发布 我第一次使用 SQLite 我已遵循所有建议 但我的 sqlite3 prepare v2 调用每次都会收到 SQLITE ERROR 1 这是我的控制器的代码

  • Paper_Trail：显示版本之间的差异

    我是 Rails 新手 使用 RubyMine 作为 IDE 我有 Paper Trail 保存数据 xoi qb 的早期版本 我的视图当前显示了我想要的当前和以前的数据 但我想显示当前版本 xoi qb 和以前版本 xoi qb 之间的差

  • TINYMCE 设定焦点...只是行不通

    我试过了 tinyMCE execInstanceCommand content mceFocus 我试过了 tinyMCE execCommand mceFocus false content 它们似乎都不起作用 好吧 我陷入了同样的问题

  • 在 Swagger Open API 3.0 中使用另一个参数时如何指示有条件地需要一个参数

    我已经创建了一个 RESTful API 现在正在为该 API 的使用定义 Open API 3 0 JSON 表示形式 当存在另一个参数时 我需要有条件地使用一个参数 所以我也不能真正使用required true or required

热门标签