问题标签 [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.
swagger - 开放 api 中基于请求的响应
嗨,我正在学习开放 API 规范,我对请求和响应有疑问 如此链接中描述 的路径有一个 requestBody 对象和一个 Responses 对象。但是我必须定义对于特定的输入,应该有特定的输出以及相应的错误代码如何在开放 API 规范中实现这一点
提前致谢
mocking - OpenAPI 3.0 模拟生成器
我正在学习 OpenAPI 规范。是否有任何工具可以基于 YAML 格式的 OpenAPI 定义来模拟 API?
swagger - Swagger 2.0:具有不同路径但请求和响应相同的多个 Path 对象
由于一些向后兼容的原因,我需要同时支持路径/ab
和/a-b
.
两条路径的请求和响应对象将是相同的。
我可以在我的 Swagger 规范中有类似下面的内容,这样我就不必为这两个路径重复请求和响应对象定义。
python - 开放 API 规范和 App Engine 端点
我使用 endpoints-proto-datastore 库在 App Engine 上开发了一个 API。在这一点上,我正在探索使用 Swagger 创建 Endpoints 规范,但不知道如何进行。Google 的Endpoints 文档中指出了对此的支持,但没有太多可以开始的地方,尤其是对于 Python。
如果可能的话,我想继续只使用端点库和 webapp,而不是去 Flask,这似乎有点矫枉过正。关于如何进行的任何提示?
swagger-2.0 - 如何在 Swagger Editor 中发送 JSON 对象作为多部分请求的一部分?
我正在使用 Swagger Editor 编写 API 文档,但遇到包含 JSON 对象的多部分 POST 请求的问题。这是我的 Swagger YAML 文件:
当我执行请求时,我得到如下 curl 命令:
但我希望得到这个:
也就是说,body 参数应该与键名一起发送param
。
java - 在 swagger-parser 中防止链接/文件系统遍历
我们正在使用https://github.com/swagger-api/swagger-parser来验证用户上传的 swagger 文档。我相信 swagger 可以链接到外部文档或 url 以获取架构定义或其他资源,这会给我们的应用程序带来安全风险。如何在 swagger 解析器中禁用链接或文件系统遍历?
rest - OpenAPI 规范以外的规范来记录一个 RESTful API
首先要对 OpenAPI 规范本身有个清晰的认识,我们来看看它的官网(https://github.com/OAI/OpenAPI-Specification)是如何定义的:
OpenAPI 规范的目标是为 REST API 定义一个与语言无关的标准接口,它允许人类和计算机在无需访问源代码、文档或通过网络流量检查的情况下发现和理解服务的功能
问: OpenAPI 定义了一个关于如何用 YAML 或 JSON 编写 API 文档的规范。现在问题出现了,如果它是完成这项工作的唯一规范吗?还是有其他相同的选择?
我在网上查了资料,但没有得出任何结论。
注意:这个问题可能会被问到软件推荐,但由于“规范”不能称为“软件”,我决定在 stackoverflow 上问它。
swagger - Swagger / OpenAPI - Diffrent model representations depending on authorization level
How do i use the Swagger models when i have diffrent representations for each model depending on the authorization level.
For example, a country model for an administrator looks like this:
However, just a regular user model looks like this
I was considering to place the model definitions in the response like this:
I am not really sure if my "solution" is the correct way to handle this.
swagger - OpenAPI 规范连接被拒绝
我的 OpenAPI 规范文件有问题。我试图调用一个暴露的 url 来“获取”一个 id,但是每次我将服务转发到我的本地然后尝试通过 API 文档发送请求时,我的连接都被拒绝了。我将不胜感激任何帮助。我期望的 id 将采用 JSON 格式。下面是我的规格文件
swagger - 如何在 swagger 规范中表示十进制浮点?
我想在我的 api 文档中用 2 位表示小数,用 1 位表示小数。我正在使用 swagger 2.0,规范中是否有内置定义类型或任何其他“圆形”参数,或者我唯一的选择是使用“x-”扩展名?