问题标签 [openapi]

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 投票
0 回答
3846 浏览

swagger - swagger-codegen-cli:java.lang.RuntimeException:缺少招摇输入或配置

我正在尝试在命令提示符下执行此命令,以生成 python 代码:

它向我显示了这个错误:

当我在浏览器中打开这个文件时,它包含:

0 投票
1 回答
372 浏览

python - 在 python 中抓取以使用开放 api

我想抓取“www.naver.com”,所以我尝试使用开放 api 抓取,我在下面编写了代码:

但python shell只显示这个

为什么会这样?那个蟒蛇壳跟我说话呢?我正在使用 Windows 8.1 64x,python 3.4.4

0 投票
1 回答
184 浏览

java - 如何通过 IntelliJ open api 获取依赖列表

我正在为 IntelliJ IDE 开发一个插件,我想显示属于当前项目的依赖项。有没有办法通过 IntelliJ open api 获取依赖项列表?

0 投票
1 回答
198 浏览

swagger - 如何在 API 中定义,从哪个版本支持路径/参数

我们有一个不断增长的 Swagger API/openAPI,并且为了记录我们喜欢在路径或参数(可能还有定义)上记录的更改,因为它是可用的 API 版本。

swagger 规范知道该info.version领域,但在pathsparameters我找不到引用此版本的内容。

也许以like开头的供应商扩展可能会有所帮助。至少验证不会使用它们失败。x-...x-since

但是这个用例可能有任何现有的实现吗?

0 投票
1 回答
1329 浏览

api - 在 swagger 2.0 (openapi) 中,如何在 POST 和 PUT 请求之间有不同的资源定义?

如果我们查看消息 API(例如),我希望它能够

  • 创建消息
  • 收到消息
  • 更新消息

一条消息包含一个外部引用(来自消费者的唯一 id)

  • 此 external_id 应在创建时使用 POST 请求设置
  • 此 external_id 无法使用 PATCH 更改

实施它的解决方案是什么?

API 示例:

我看到的唯一解决方案:

  • 使用 allOf 定义 2 个定义(Message 和 UpdatedMessage)
  • 不使用 PATCH 方法或 GET/POST 方法中的定义

有没有更好的解决方案来实现这一目标?理想的解决方案是只有一个 Message 定义,并在 PATCH 方法中覆盖 Message 定义(删除字段)。

我不知道这是否可能。

谢谢

0 投票
1 回答
775 浏览

enums - Swagger,YAML:请求和响应对象模型是相同的,除了一个字段

我正在为 API 定义 swagger 定义,并且遇到了这个用例。

请求和响应对象模型定义看起来完全一样。但是,对象中有一个字段在 get 操作期间返回更多枚举值,但限制为 put 操作的最小枚举值。是否可以有条件地为同一字段引用不同的枚举值,从而避免重复定义。为了克服这个限制,我不想为请求和响应重新创建整个模型定义。

这是我的例子,

在上面,有两件事我担心。1) 对于 EntryRequest,API 只接受 ENABLE/DISABLE 进行 PUT 操作,而 API 在 GET 操作中返回所有这些。我想有条件地创建对 entryStatus 属性的引用。可能吗?2) 此外,对于 EntryRequest 和 EntryResponse 对象模型,除了 entryStatus 之外的所有内容都是相同的。为了表示 entryStatus 字段的区别,我也不想复制它。

有没有办法做到这一点?

编辑: 当我对此了解更多时,我觉得这更像是一个与 yaml 相关的查询。但是我想在这里看看是否有人遇到过类似的情况以及他们是如何处理的。或者看看我是否有任何关于如何处理这个问题的建议。为了将不同的枚举标记到同一个字段,我想我可以这样做,

但这仍然会强制我创建具有不同映射到 entryStatus 字段的请求和响应对象的副本。我想知道是否有更好的方法来处理这个问题。

0 投票
11 回答
81698 浏览

mocking - Swagger/OpenAPI 模拟服务器

我在 Swagger 文件中有一个 API 参考。我想创建一个非常简单的模拟服务器,这样当我调用例如:

mymockurl.com/users它将返回一个预定义的 JSON(无需连接到数据库)。

最简单的方法是什么?我不是后端的人。

0 投票
1 回答
11962 浏览

swagger - swagger 安全方案对象的“范围”字段用于什么?

这是Swagger Specification中的 securityDefinitions 示例。write:petsread:pets的用途是什么?这是路径的一些类别吗?

0 投票
4 回答
8088 浏览

django - Django REST 框架 Swagger 2.0

很难配置 Swagger UI 以下是非常解释性的文档:https ://django-rest-swagger.readthedocs.io/en/latest/

不推荐使用 YAML 文档字符串。有人知道如何从 python 代码中配置 Swagger UI 吗?或者我应该更改什么文件来分组 api 端点、向每个端点添加注释、在 Swagger UI 中添加查询参数字段?

0 投票
1 回答
6490 浏览

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

我试图将以下 JSON 映射到 OpenAPI 2.0 (Swagger 2.0) YAML 定义,但我不确定如何将混合数组类型设置到我的架构中:

现在,我的 OpenAPI 定义有:

但这不允许数组内的整数。

有没有办法定义一个混合类型的数组?