如何在 OpenAPI (Swagger) 中记录动态查询参数名称?
有没有办法记录以下查询? GET api/v1/users?name1=value1&name2=value 查询参数名称是动态的，将从客户端接收. 我正在使用最新的 Swagger API. 解决方案 可以使用 OpenAPI 3.x 描述自由格式的查询参数，但不能使用 OpenAPI 2.0 (Swagger 2.0).该参数必须具有 type: object 和序列化方法
..
swagger-editor相关内容
我如何表示“授权:承载 <token>"在 Swagger 规范中 (swagger.json)
我试图传达身份验证/安全方案需要设置如下标头: 授权:Bearer 这是我基于 大摇大摆的文档: securityDefinitions:API密钥:类型:apiKey名称:授权在:标题安全:- API密钥:[] 解决方案 也许这会有所帮助: 招摇:'2.0'信息:版本:1.0.0标题:基于“基本身份验证示例"描述:>如何将 Auth 与 Swagger 一起使用的示例.主机:bas
..
从 Swagger 文档生成 Yaml 或 Json 文件
我已经使用 swagger-springmvc 注释开发了一些由 swagger 记录的 Rest web 服务.现在，我想使用 swagger-editor 生成客户端 Rest web 服务代码，但 swagger-editor 需要 Yaml 或 Json 文件.你知道是否有办法生成这个文件?提前致谢 编辑:可以通过使用 swagger-mvn-plugin 来完成，但我没有找到如何做
..
具有动态键值哈希映射的 Swagger 复杂响应模型
我正在努力使用 swagger 的语法来描述响应类型.我要建模的是具有动态键和值的哈希映射.这是允许本地化所必需的.语言可能会有所不同，但应始终提供英语. 响应在 JSON 中如下所示: {编号:“1234"，名称: {en: "英文文本",de:“德国文本"}} 我的第一次尝试是这样的，但我不知道如何写名字的部分.AdditionalProperties 似乎是一个关键，但我无法理解它
..
如何格式化 Swagger 2.0 文本描述?
我想格式化我的 Swagger API 描述，以便它们不是简单的文本段落.最好，我想给它添加一个小桌子. 我没有在 Swagger 描述中找到有关文本格式的在线参考.如果我启动 Swagger Editor，然后打开 Instagram 示例(文件 \ 打开示例 \ Instagram.yaml), 我看到 yaml 文件中的第一个描述显示了一些格式，包括超链接和边界框: [注册你的客户
..
我可以从 json 文件创建存根 swagger 模型定义吗
是否有工具可以让我从示例 JSON 生成 Swagger yaml 定义模型? 我会进入并编辑和清理 yaml，但如果有什么东西可以基于大型或复杂的示例 json 对象来剔除 yaml 的结构，那就太好了. 解决方案 您可以使用具有此功能的 Apigee API Studio: http://apistudio.io/ 点击插入菜单，然后点击新建模型.形成一个 JSON
..
Swagger Schema 错误不应具有其他属性
我正在尝试创建 swagger json 并尝试检查它的有效性http://editor.swagger.io 验证json后，上面提到的编辑器给出以下错误: 架构错误不应该有额外的属性附加属性:组件跳到第 0 行 如果由于某种原因我无法在根级别定义名为 components 的元素，我将在其中拥有某种 json 架构，那么在 API 操作的 requestBody 架构上执行 $ref
..
作为参数传递的 swagger 对象可以在 swagger-ui 中具有默认值吗?
我定义了一个以 MyObject 作为参数的路径.MyObject 具有猫和狗的属性.这些有默认值.在 swagger-editor 中，该示例未显示默认值，但试用确实创建了一个具有正确默认值的 MyObject. 在 swagger-ui 中，我可以在 Models 下看到默认值，但在 API 中看不到.有没有办法设置这些默认值?招摇:'2.0'信息:标题:将具有默认属性的对象作为参数传递
..
Swagger 编辑器字典参数定义
我正在为如何在 swagger 编辑器中定义字典类型而苦苦挣扎.我的 POST 方法的参数之一称为“角色"，它的值是一个字典，其中键是电子邮件地址，值是一个整数. 解决方案 Swagger 支持键为字符串的关联数组/哈希图/字典.字典是通过使用object 模式和additionalProperties 关键字来定义的，该关键字指定键/值对的值类型.没有提到键类型，因为键总是字符串.
..
Swagger 编辑器显示路径参数的“架构错误:不应具有附加属性"错误
我正在创建一个 OpenAPI (Swagger) 定义并在 http://editor.swagger.io.出于某种原因，Swagger 编辑器显示此错误: 路径中的架构错误['/some-endpoint/{id}/name-and-address'].get.parameters[0]不应该有额外的属性附加属性:类型、allowEmptyValue、枚举、名称、输入、描述、必需跳转到第
..
Swagger 文件 (YAML) 中的重载描述
我在编写 swagger 文件时遇到问题.当我描述一个参数时，该描述被同一个参数的 $ref 的描述重载(参见下面的例子). a-body:描述:本体类型:对象特性:我的参数:描述:完整描述$ref: '#/定义/参考'定义:参考:类型:对象要求:[请求]描述:http 参考特性:要求:类型:字符串 结果:描述超载 有人可以帮我解决这个问题吗? 解决方案 $ref 覆盖其所有同级
..
Swagger 创建 API 文档:Swagger Editor
我正在使用 swagger 来记录我的 REST API 服务.我有我提供给服务的特定输入.我正在使用 swagger 编辑器自己创建 YAML 代码.我面临的问题是我无法将输入类型获取为 XML，默认情况下它采用 JSON.我的 yaml 代码中是否有任何问题.代码如下: 招摇:“2.0"信息:标题:经销商订单更新描述:Markdown 中的 API 描述.版本:1.0.0host: #这里不
..
swagger-editor 将 json 或 yaml 保存到远程后端的选项是什么?
我知道 Swagger 编辑器将 api 文档保存到本地浏览器缓存中(“下载 Yaml/Json"和“导出 Yaml/Json"). 但是如果我想将它保存到远程服务器中，然后我可以从另一个浏览器继续编辑它. 是否有已知的 Swagger-editor 后端可供我使用? 提前致谢. 解决方案 swagger-node 项目 内置编辑器并将文件保存在您的文件系统中. 按
..
如何在 Swagger 中将 https:///swagger 更改为自定义
我的任务是将 Swagger 安装到 Web API 项目中. 已安装:来自 nuget 的最新版本的 Swashbuckle.(Swashbuckle.Core.Net45 和 Swashbuckle.Net45) 自定义:App_Start\SwaggerConfig.cs.我能够自定义(更改样式、添加徽标、修改说明). 现在我们需要将 https://[your-url]/
..
Swagger:不允许的附加属性:allOf
我正试图通过使用 allOf 来弄清楚这个招摇的 API 继承的东西.这是我的 swagger yaml 文件. 招摇:'2.0'信息:标题:测试 API版本:'1'基本路径:/api/v1方案:- https产生:- 应用程序/json路径:/用户:得到:摘要:用户集合标签:- 用户回应:200:描述:用户列表架构:$ref: "#/定义/用户"500:$ref: "#/responses/B
..
从 Swagger 规范生成 nodejs
所以我用 swagger 编辑器记录了我的整个 API，现在我有了我的 .yaml 文件.我真的很困惑我现在如何使用它并生成整个 nodejs 东西，以便所有这些函数都已经定义，然后我只需用适当的代码填充它们. 解决方案 Swagger Codegen为各种语言和框架(包括 Node.js)生成服务器存根和客户端 SDK. 要生成 Node.js 服务器存根，请使用 -l nodej
..
在线的swagger编辑器可以通过地址栏输入一个YAML url吗?
我想访问 https://editor.swagger.io/ 但需要 YAML 文件根据 URL 参数预加载. 所以如果我想查看 https://github.com/OAI/OpenAPI-Specification/blob/master/examples/v3.0/petstore.yaml，我应该能够将其作为输入提供给可通过互联网访问的 swagger 编辑器. 这可能吗?
..
如何定义 Swagger 2.0 JSON 以填充 Swagger UI 中的默认正文参数对象?
我们当前的部署模式要求我手动编写我的 swagger json 输出，这些输出将由我公司使用的基于 Swagger 的 UI 使用.我希望我正在编写的 json 提供“默认"值来填充所有输入字段的 Swagger UI，包括 body 输入参数.我的 body 参数是一个引用对象，如下所示.我如何定义返回的 swagger JSON 以在单击“尝试此操作"时自动填充请求的正文部分? 在 Sw
..
node.js 上 swagger 中的可为空字段
我花了很多时间试图找到在 Node.JS 中创建 swagger 文档的解决方案.主库是 swagger-node，您可以在其中创建一个 swagger yaml 文件，然后向其中添加控制器.它会自动在您的应用程序中提供 swagger ui 文档并对请求进行验证和验证.响应您在 yaml 中指定的模型. 这很好，但是我有一个要求，我希望某些字段能够明确返回或接受 null 作为值，例如:
..
如何链接到 Swagger 中的另一个端点
我正在为未来的公共 API 编写 Swagger 规范，该规范需要非常详细和清晰的文档.有没有办法在 swagger.yml 文件中的其他位置引用/链接/指向另一个端点? 例如，这是我想要实现的目标: 路径:/我的/端点:邮政:标签:- 一些标签总结:做事描述:>这个端点做事.看到/my/otherEndpoint 的东西 # 这里我想要某种超链接操作 ID:做事消耗:- 应用程序/js
..