8得票1回答
如何在OpenAPI 3.0中定义具有两个可选参数的路径?

我在SwaggerHub注册并创建了一个使用OpenAPI 3.0的新API。在我的API中,“/tasks”路径有两个非必填参数,但我无法将它们设置为非必填 - 编辑器显示“不允许值”错误。 以下是我的API定义: openapi: 3.0.0 info: description: ...

8得票1回答
Swagger:尽管使用不同的参数,但“等效路径已存在”

我正在尝试将Atom发布协议(RFC5023)转化为Swagger/OpenAPI规范,以便练习编写这些规范。 我遇到了以下问题:在Atom中存在不同类型的URI,例如集合和成员URI。我的想法是这样记录它: paths: /{CollectionURI}: get: ...

8得票3回答
Swagger Editor OpenAPI 3上的文件上传在尝试使用时没有显示文件浏览器

我正在使用 OpenAPI 3.0 版本的 Swagger Editor。我需要记录一个上传图片的路由信息。当我尝试"Try it out"时,请求体中没有文件浏览器来选择要上传的图片,而是返回了一个JSON字符串,里面包含参数的名称和类型。 以下是该路由的YAML描述: openapi:...

8得票1回答
如何在Swagger UI 3.x中格式化描述中的代码块?

我希望在API描述中放置一个Markdown代码块,但是Swagger UI似乎将其读取为单行代码片段。我目前有: description: | This API was created to allow interaction with the Image Status Datab...

8得票2回答
向Angular项目添加Swagger编辑器

我想把Swagger UI和Swagger Editor插入我的Angular项目中,使其看起来像这样:http://editor.swagger.io/?docExpansion=none 感谢以下说明,我已经能够将Swagger UI添加到我的Angular项目中:https://git...

8得票1回答
如何在Swagger中提示客户端ID和客户端密钥

如何允许用户在Swagger中输入客户端ID和客户端密钥?下面是我的安全定义,但它提示的是通过客户端ID和客户端密钥获取的访问令牌,我尚未能使其请求客户端ID和客户端密钥。 securityDefinitions: api_auth : type: oauth2 authoriz...

7得票2回答
如何在Swagger规范中定义不同示例的数组?

我正在尝试使用静态swagger文件记录一个API,它可以返回一些JSON数据,其中包含一个类似于以下内容的数组: [ { "type": "type A", "field A": "this field is specific to type A" }, { ...

7得票2回答
Swagger UI:数组中的多个匿名对象

我正在为一个API编写Swagger文档,其中一个端点返回许多嵌套对象和参数。 然而,有一个返回的数组不会返回常规参数。相反,它返回两个匿名对象,保存了这些参数。 "balanceDisplaySettings": [ { "type": "Balance", "la...

7得票1回答
Swagger架构错误不应该有额外的属性。

我正在尝试创建Swagger JSON并尝试检查其在http://editor.swagger.io上的有效性。 在验证JSON时,上述编辑器会给出以下错误: Schema error should NOT have additional properties additionalProp...

7得票1回答
Swagger - 更改项目目录

我在我的工作空间的根目录下创建了一个新项目(nodeJS),一段时间后,我想将项目的客户端和服务器端分离。为此,我在项目的根目录下创建了两个文件夹(server和client),并将所有文件和目录移动到相应的文件夹中。 之后,我无法启动服务器,因为它显示找不到swagger.yaml文件(我...