Swagger:使用 ref 添加描述
我想向引用其定义的对象属性添加描述.类似的东西: 新信用卡:类型:对象特性:计费电话:描述:持卡人电话$ref: "#/定义/电话号码" 但编辑器警告将跳过描述属性: 额外的 JSON 参考属性将被忽略:描述 我发现了一个不太优雅的解决方法，它适用于编辑器，但不适用于 Swagger UI(不确定这可能是由于最近更新到 3.0.2 版本的 Swagger UI) 新信用卡:类型:对象
..
swagger-editor相关内容
如何在某些操作而不是其他操作所需的定义中创建字段
我正在用 yaml 编写我的 swagger 定义.假设我有一个看起来像这样的定义. 路径:/有效载荷:邮政:摘要:创建有效负载...参数:- 在:身体名称:有效载荷描述:新的有效载荷要求:真实架构:$ref: "#/定义/有效载荷"放:摘要:更新有效负载...参数:- 在:身体名称:有效载荷描述:更新了现有的有效载荷要求:真实架构:$ref: "#/定义/有效载荷"...定义:有效载荷:特性
..
Swagger:“等效路径已经存在"尽管参数不同
我正在尝试将 Atom 发布协议 (RFC5023) 转换为 Swagger/OpenAPI 规范以练习编写这些规范. 我遇到了以下问题:在 Atom 中有不同类型的 URI，例如集合和成员 URI.我的想法是像这样记录它: 路径:/{集合URI}:得到:摘要:列出集合成员...邮政:摘要:创建资源...参数:- $ref: "#/parameters/CollectionURI"/{M
..
我如何表示“授权:持有者<令牌>"在 Swagger 规范 (swagger.json) 中
我试图传达身份验证/安全方案需要如下设置标头: Authorization: Bearer 这是我基于 swagger 文档: securityDefinitions:API密钥:类型:apiKey名称:授权在:标题安全:- APIKey:[] 解决方案 也许这会有所帮助: 招摇:'2.0'信息:版本:1.0.0标题:基于“基本身份验证示例"描述:>如何将 Auth 与 Swagge
..
如何在不破坏 Codegen 的情况下在 Swagger 中添加几个示例来响应?
我一直在尝试根据 官方文档(请参阅请求和响应正文示例的最后一个代码块)但它似乎没有按预期工作. 考虑以下最小示例: 招摇:“2.0"信息:描述:描述版本:“1"标题:标题路径:/东西:帖子:产生:- 应用程序/json回应:201:描述:它起作用了内容:应用程序/json:架构:$ref: "#/definitions/StatusMessage"例子:成功没有消息:价值:代码:“0000
..
生成客户端代码时可以更改包名称
我正在使用 Swagger Edtior 为 API 生成客户端 Scala 代码.我粘贴了 json 然后做了一个 Generate Client/Scala.它给了我一个 的默认根包 io.swagger.client 我看不到任何明显的指定不同内容的方法.可以这样做吗? 解决方案 步骤 (1):创建文件 config.json 并添加以下行并定义包名称: {"modelP
..
Swagger 错误显示需要在路径或操作级别定义参数
我收到以下错误: 声明的路径参数“imageId"需要定义为路径路径或操作级别的参数 这是我的swagger定义的快照 '/api/v1/images/{unitnumber}/{type}/{imageId}':删除:标签:- 图片总结:'总结'描述:“描述"操作 ID:删除图像消耗:[]产生:- 应用程序/json参数:- 名称:单元号在:路径要求:真实类型:字符串- 名称:类
..
Swagger Editor 3.8 示例不适用于参考数组架构
这个问题是这个类似问题的后续问题 - 因为@Helen 要求提出一个新问题. 似乎数组类型模式只接受“example"，而不接受“examples".以下架构在 editor.swagger.io 站点上产生错误: 信息:标题:Example Inc. REST API 1.0 版版本:'1.0'openapi: 3.0.0组件:模式:用户参考:特性:评论:类型:字符串中间名字:类型:字符
..
带括号和变量名的 OpenAPI 参数
我正在开发一个允许使用以下 URL 进行搜索的 API: GET https://example.com/api/data?search[field1]=value1获取 https://example.com/api/data?search[field2]=value2获取 https://example.com/api/data?search[field1]=value1&search[fi
..
Open API 3 - 在响应中的单个内容类型上添加标头
我的规范有一个带有 200 响应代码的路径，该响应代码可以访问多种内容类型，我想将 Content-Disposition 标头添加到这些内容类型之一. 这是一个示例: openapi: '3.0.3'信息:...服务器:...路径:/例子:...得到:...回应:'200':内容:应用程序/json:...申请/pdf:编码:文件:标题:内容配置:架构:类型:字符串例如:附件；文件名=“
..
Swagger 3.0 架构错误“不应具有附加属性"
下面这个错误是什么意思?(在 Swagger 编辑器中运行) 架构错误不应具有附加属性 additionalProperty:/buildinfo,/clearcache,/countries/{countryId}/cinemas/{theatreid}/screens/{screenid}/layout,/countries/{countryId}/cinemas/{theatreid}
..
OpenAPI 3.0 - oneOf 中的 allOf
以下 YAML: openapi: 3.0.0信息:书名:测试版本:1.0.0路径:/测试:得到:总结:测试回应:'200':描述:测试内容:应用程序/json:架构:其中之一:- 所有的:- 类型:对象特性:第一:类型:字符串- 类型:对象特性:第一B:类型:字符串- 所有的:- 类型:对象特性:第二个:类型:字符串- 类型:对象特性:第二个B:类型:字符串 在 swagger 编辑器中根本
..
Swagger 编辑器显示“架构错误:不应具有其他属性"；路径参数错误
我正在使用 http://editor.swagger.io 来设计 API，但出现错误我不知道如何解决: 路径中的架构错误['/employees/{employeeId}/roles'].get.parameters[0]不应该有额外的属性附加属性:类型、格式、名称、输入、描述跳到第 24 行 我以类似的方式定义了其他端点，并且没有收到此错误.我想知道我是否有缩进或未闭合引号的问题，但似乎
..
Slate vs Swagger-哪个更好，哪个有更多选择？
我必须记录我的API。我必须使用其中任何一个 Slate 或 Swagger 。我想知道哪个有更多的选择，利弊，哪个更好。 解决方案 Swagger和Slate提供两种不同的选择目的。 Swagger是尝试以一种描述RESTful API的标准化方式（例如，类似于 ApiBlueprint ） Swagger是基于JSON的API定义格式，用于描述REST API。 〜 API
..
如何在Swagger编辑器中使用Cookies
我想记录和测试一个API，该API在 http：//editor.swagger中使用基于Cookie的身份验证。 io / 。举一个简单的例子：如何在下面的YAML中编写代码，/ login操作创建一个Cookie，而该Cookie必须传递给/ showMySecretStuff？ swagger：'2.0' 信息： 标题：测试API 版本：'1' 主机：my.test.com s
..
将Swagger编辑器添加到Angular项目中
我想将Swagger UI和Swagger编辑器插入到我的Angular项目中.使其看起来像这样: http://editor.swagger.io/?docExpansion=none 由于以下说明，我已经能够将Swagger UI添加到我的Angular项目中: https ://github.com/agoncal/swagger-ui-angular6 仍然缺少Swagger编
..
如何在swagger 3.0中自动添加基本身份验证，而无需用户在授权按钮上键入?
我正在使用swagger 3.0，并且在swagger文档中具有多个端点. 我希望用户不要每次都在授权按钮上输入凭据. 有什么办法可以在index.html或yaml文件中包括身份验证以自动授权用户. 谢谢. 解决方案 Swagger UI 3.13.0+为此提供了preauthorizeBasic方法.假设您的API定义包括用于基本身份验证的安全方案: swagg
..
如何在OpenAPI 2.0中为同一操作定义path和formData参数?
我有一个看起来像/test/{id}/relationships/image的图像上传端点.我想使用OpenAPI 2.0(Swagger 2.0)描述此端点. 端点同时具有path和formData参数.我尝试了以下方法: swagger: '2.0' info: title: API version: 1.0.0 host: api.server.de schemes:
..
Swagger/OpenAPI 3.0问题以及响应示例
这是我正在Swagger编辑器上在线查看的OpenAPI 3.0定义的简化版本.我正在尝试针对错误代码401和403的两个响应，它们共享相同的架构，并显示不同的示例-这似乎不起作用，并且我仍然将引用的类型作为示例. 您能帮我弄清楚定义有什么问题吗? openapi: 3.0.0 info: version: '1.0' title: A service paths: /do
..
如何在OpenAPI/Swagger中递归引用类型定义?
我正在Swagger编辑器中编写OpenAPI定义. 我的一个类型定义包含一个数组，该数组包含与父类型相同类型的子元素. IE.像这样的东西: definitions: TreeNode: type: object properties: name: type: string description: The name o
..