swagger-2.0相关内容

Swagger 编辑器字典参数定义

我正在为如何在 swagger 编辑器中定义字典类型而苦苦挣扎.我的 POST 方法的参数之一称为“角色"，它的值是一个字典，其中键是电子邮件地址，值是一个整数. 解决方案 Swagger 支持键为字符串的关联数组/哈希图/字典.字典是通过使用object 模式和additionalProperties 关键字来定义的，该关键字指定键/值对的值类型.没有提到键类型，因为键总是字符串. ..
发布时间：2021-09-01 20:21:23 其他开发

Swagger 编辑器显示路径参数的“架构错误:不应具有附加属性"错误

我正在创建一个 OpenAPI (Swagger) 定义并在 http://editor.swagger.io.出于某种原因，Swagger 编辑器显示此错误: 路径中的架构错误['/some-endpoint/{id}/name-and-address'].get.parameters[0]不应该有额外的属性附加属性:类型、allowEmptyValue、枚举、名称、输入、描述、必需跳转到第 ..
发布时间：2021-09-01 20:21:12 其他开发

swashbuckle 媒体类型应用程序/八位字节流

我有一个将媒体类型生成为应用程序/八位字节流的端点.但是，当我生成 swagger json 时，它将“生产"指定为“应用程序/json"我没有在 swagger 中做任何特殊的配置.我所做的只是导入 swagger nuget 并保持默认配置不变.请在端点下方找到: [HttpPost][路线(“文件/方法1")]public HttpResponseMessage method1([Fro ..
发布时间：2021-09-01 20:20:58 其他开发

Swagger 2:在数组类型的查询参数中使用枚举引用

无法获得如何在数组参数中使用带有枚举值的字符串类型的引用.我可以在 items 键中进行引用并且它正在工作，但是 Swagger 产生错误:不是有效的参数定义 Web UI 生成界面，但它有 textarea 而不是我期望的多选框. 正确的做法是什么? 我的代码: 招摇:'2.0':路径:/测试:得到:参数:- 在:起源名称:状态描述:产地要求:假架构:类型:数组项目:$re ..
发布时间：2021-09-01 20:19:45 其他开发

Swagger 文件 (YAML) 中的重载描述

我在编写 swagger 文件时遇到问题.当我描述一个参数时，该描述被同一个参数的 $ref 的描述重载(参见下面的例子). a-body:描述:本体类型:对象特性:我的参数:描述:完整描述$ref: '#/定义/参考'定义:参考:类型:对象要求:[请求]描述:http 参考特性:要求:类型:字符串 结果:描述超载 有人可以帮我解决这个问题吗? 解决方案 $ref 覆盖其所有同级 ..
发布时间：2021-09-01 20:19:31 其他开发

返回正确定义 SDK 响应的对象数组

我有一个典型的 RESTful 端点，它返回一组模型，但生成的 Ruby SDK 返回一个新模型，Matters 而不是模型数组.我可以破解生成的源代码以返回 Array 但这是一个维护问题.如何指定我要在 YAML 中返回 Array? 路径:/事项:得到:...回应:200:架构:$ref: "#/定义/事项"...定义:事情:类型:“对象"特性:ID:类型:“字符串"描述 ..
发布时间：2021-09-01 20:18:48 其他开发

Swagger 生成器无法识别控制器

我有这个 yaml 文件: ---招摇:“2.0"信息:版本:0.1.0标题:“我的 API"主机:本地主机:3000基本路径:/api方案:- http路径:/天气:得到:x-swagger-router-controller: "weatherController"描述:“将指定城市的当前天气返回给调用者"操作 ID:getWeather参数:- 名称:城市在:查询描述:“你想要天气的城市， ..
发布时间：2021-09-01 20:18:40 其他开发

Swagger 组合/继承

我正在尝试使用 Swagger 记录 REST API.来自我们 API 的简化 JSON 响应如下所示: {“数据": {“类型":“人"“id":“1"“属性": {“姓名":“乔"“年龄":32...}“链接":{...}}} 或 {“数据": {“类型":“工作"“id":“22"“属性": {"name": "经理""位置": "某处"...}“链接":{...}}} 他们对成功 ..
发布时间：2021-09-01 20:18:31 其他开发

在 swagger-ui 中使用多个 Json 文件

我正在使用 Swagger-ui 2.1.4 版，我在本地托管了它并提供我自己的 Json 文件和 API，它可以很好地打开文档并列出 json 文件中的所有方法，但是 json 文件变得非常大，我想使用多个 json 文件并希望一次打开一个，我愿意不知道如何提供多个 json 文件并使用它们，因为我在索引页面中提供的单个文件是这样的: var url = window.location.se ..
发布时间：2021-09-01 20:18:16 其他开发

如何将 ref 用于示例 Swagger?

JSON 规范: “响应":{“200":{"description": "Успешный ответ сервиса",“架构":{"$ref": "#/definitions/BaseResponse"},“例子": {“应用程序/json":{“状态":真实，“回复": {"$ref": "#/定义/产品"},“错误":空}}}} 结果: 但我需要: {“状态":真实，“回复" ..
发布时间：2021-09-01 20:18:02 PHP

API 方法排序:Swagger 3.0.2 版

我正在使用 swagger version 3.0.2 ，我也遵循了 这个答案 但对方法顺序没有影响. window.onload = function() {const ui = SwaggerUIBundle({.....apisSorter:“阿尔法"，布局:“独立布局"}) 谁能说出改变 API 方法顺序的最佳方法. 解决方案 Swagger UI 3.0.7 添加了对 2.x ..
发布时间：2021-09-01 20:17:52 其他开发

我们可以设置全局“消耗"吗?和“产生"在招摇?

在每个路径中我需要设置consumes 和produces.我可以全局设置它们吗? post:概括: ""描述: ""消耗:- “应用程序/json"- “应用程序/xml"产生:- “应用程序/xml"- “应用程序/json" 解决方案 好的.您可以在规范的根级别指定 consumes 和 produces，它们将被所有操作继承.如果需要，可以在操作级别覆盖全局 consumes 和 p ..
发布时间：2021-09-01 20:17:35 其他开发

如何在 SwaggerUIBundle 中设置请求拦截器?

在我们的 swagger.json 中，我们将 basePath 设置为 /api，但是，当应用程序部署在 docker 容器中时，上下文路径不是/api.这可能是不同的事情，我们不知道它是什么，所以我们不能对其进行硬编码. 我正在尝试按照以下指南设置 requestInterceptor，以便捕获请求并修改 url 路径: https://swagger.io/docs/swagge ..
发布时间：2021-09-01 20:17:11 其他开发

Swagger 标头定义

我似乎无法找到是否可以声明一个标头对象以便在响应标头中重用它，有一些示例定义了响应模式的对象，但它不会转置为响应标头.我只设法制作了这样一个可重用的响应对象: 响应:下载确定:描述:下载好标题:内容长度:描述:响应长度类型:整数文件长度:描述:文件长度类型:整数 但正如我所说，我只想保留标题部分. 这里是我想使用它的地方: 回复:200:描述:下载好标题:$ref: '#/defin ..
发布时间：2021-09-01 20:17:08 其他开发

Swagger:不允许的附加属性:allOf

我正试图通过使用 allOf 来弄清楚这个招摇的 API 继承的东西.这是我的 swagger yaml 文件. 招摇:'2.0'信息:标题:测试 API版本:'1'基本路径:/api/v1方案:- https产生:- 应用程序/json路径:/用户:得到:摘要:用户集合标签:- 用户回应:200:描述:用户列表架构:$ref: "#/定义/用户"500:$ref: "#/responses/B ..
发布时间：2021-09-01 20:15:14 其他开发